Cisco-IOS-XR-ipv4-pim-cfg API API Reference

API generated from Cisco-IOS-XR-ipv4-pim-cfg@2017-10-15.yang

API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
   Key  Mandatory  Optional

Paths

PIM - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/

Update operation of resource: pim

pim_schema

pimbody object

Request Content-Types: application/json
Request Example
{
  : {
PIM configurationPUTPOSTDELETEGET
    : {
VRF tablePUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"vrf-name": "string", VRF name
          : {
IPV4 commandsPUTPOSTDELETEGET
            : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"rpf-proxy-address": "string", RPF Proxy Address

                  
"prefix-length": "string", Hash Mask Length for this candidate BSR

                  
"source-address": "string" Source Address

                }
              ]
            },
            : [
Configure convergence parametersPUTPOSTDELETEGET
              {
                
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

                
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

              }
            ],
            
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
            : {
Configure RPF optionsPUTPOSTDELETEGET
              
"route-policy": "string" Route policy to select RPF topology

            },
            
"multipath": "string", Enable equal-cost multipath routing

            
"register-source": "string", Source address to use for register messages

            
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
            : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"rpf-proxy-address": "string", RPF Proxy Address

                  
"prefix-length": "string", Hash Mask Length for this candidate BSR

                  
"source-address": "string" Source Address

                }
              ]
            },
            
"neighbor-filter": "string", Access-list of neighbors to be filtered
            : [
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
              {
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                    
"rp-address": "string", RP address of Rendezvous Point

                    
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                  }
                ]
              }
            ],
            
"accept-register": "string", Access-list which specifies unauthorized sources
            : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
              
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            },
            
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
            : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
              
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

              
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

            },
            : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
              
"rp-list-name": "string", Access-list specifiying applicable RPs

              
"group-list-name": "string" Access-list specifiying applicable groups

            },
            
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol

            
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

            
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
            : {
Interface-level ConfigurationPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"neighbor-filter": "string", Access-list of neighbors to be filtered

                  
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                  
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

                  
"interface-name": "string", The name of interface
                  : {
Maximum number of PIM routesPUTPOSTDELETEGET
                    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                    
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

                    
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                  },
                  : {
BFD configurationPUTPOSTDELETEGET
                    
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                    
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

                    
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

                  },
                  
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

                  
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

                  
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

                  
"interface-enable": "boolean", Enable PIM processing on the interface

                  
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

                  
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

                  
"bsr-border": "boolean" BSR Border configuration for Interface

                }
              ]
            },
            
"rp-static-deny": "string", Configure static RP deny range
            : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
              
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

              
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
              : {
Clone multicast joinsPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"source": "string", Original source address (S)

                    
"prefix-length": "string", Hash Mask Length for this candidate BSR

                    
"backup": "string", Backup cloned address (S2)

                    
"primary": "string" Primary cloned address (S1)

                  }
                ]
              },
              : {
Clone multicast trafficPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"source": "string", Original source address (S)

                    
"prefix-length": "string", Hash Mask Length for this candidate BSR

                    
"backup": "string", Backup cloned address (S2)

                    
"primary": "string" Primary cloned address (S1)

                  }
                ]
              },
              
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

            },
            : {
Configure IP Multicast SSMPUTPOSTDELETEGET
              
"range": "string", Access list of groups enabled with SSM

              
"disable": "boolean" TRUE if SSM is disabled on this router

            },
            : {
PIM BSR configurationPUTPOSTDELETEGET
              : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
                
"priority": "string", Priority of the CRP

                
"prefix-length": "string", Hash Mask Length for this candidate BSR

                
"address": "string" Address of Candidate-RP

              },
              : {
PIM RP configurationPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

                    
"priority": "string", Priority of the CRP

                    
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

                    
"mode": "string", SM or Bidir

                    
"address": "string" Address of Candidate-RP

                  }
                ]
              }
            },
            
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
            : {
Inheritable defaultsPUTPOSTDELETEGET
              
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

              
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

              
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

              
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

              
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

              
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

              
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

            },
            : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                  
"rp-address": "string", RP address of Rendezvous Point

                  
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                }
              ]
            },
            
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
            : {
Configure PIM State LimitsPUTPOSTDELETEGET
              : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
                
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

                
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

              },
              : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
                
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

              },
              : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
                
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

                
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

              },
              : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
                
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

                
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

              },
              : {
Override default maximum for number of routesPUTPOSTDELETEGET
                
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

              },
              : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
                
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

                
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

              }
            },
            
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

          },
          : {
IPV6 commandsPUTPOSTDELETEGET
            : {
Configure convergence parametersPUTPOSTDELETEGET
              
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

              
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

            },
            
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
            : {
Configure RPF optionsPUTPOSTDELETEGET
              
"route-policy": "string" Route policy to select RPF topology

            },
            
"multipath": "string", Enable equal-cost multipath routing

            
"register-source": "string", Source address to use for register messages

            
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages

            
"neighbor-filter": "string", Access-list of neighbors to be filtered
            : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                  
"rp-address": "string", RP address of Rendezvous Point

                  
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                }
              ]
            },
            
"accept-register": "string", Access-list which specifies unauthorized sources
            : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
              
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            },
            
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
            : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
              
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

              
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

            },
            : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
              
"rp-list-name": "string", Access-list specifiying applicable RPs

              
"group-list-name": "string" Access-list specifiying applicable groups

            },
            
"embedded-rp-disable": "null", Set Embedded RP processing support

            
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

            
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
            : {
Interface-level ConfigurationPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"neighbor-filter": "string", Access-list of neighbors to be filtered

                  
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                  
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

                  
"interface-name": "string", The name of interface
                  : {
Maximum number of PIM routesPUTPOSTDELETEGET
                    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                    
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

                    
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                  },
                  : {
BFD configurationPUTPOSTDELETEGET
                    
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                    
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

                    
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

                  },
                  
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

                  
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

                  
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

                  
"interface-enable": "boolean", Enable PIM processing on the interface

                  
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

                  
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

                  
"bsr-border": "boolean" BSR Border configuration for Interface

                }
              ]
            },
            : {
Set Embedded RP processing supportPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"rp-address": "string", RP address of Rendezvous Point

                  
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                }
              ]
            },
            : {
PIM BSR configurationPUTPOSTDELETEGET
              : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
                
"priority": "string", Priority of the CRP

                
"prefix-length": "string", Hash Mask Length for this candidate BSR

                
"address": "string" Address of Candidate-RP

              },
              : {
PIM RP configurationPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

                    
"priority": "string", Priority of the CRP

                    
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

                    
"mode": "string", SM or Bidir

                    
"address": "string" Address of Candidate-RP

                  }
                ]
              }
            },
            : {
Configure IP Multicast SSMPUTPOSTDELETEGET
              
"range": "string", Access list of groups enabled with SSM

              
"disable": "boolean" TRUE if SSM is disabled on this router

            },
            
"rp-static-deny": "string", Configure static RP deny range

            
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
            : {
Inheritable defaultsPUTPOSTDELETEGET
              
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

              
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

              
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

              
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

              
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

              
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

              
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

            },
            : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                  
"rp-address": "string", RP address of Rendezvous Point

                  
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                }
              ]
            },
            
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
            : {
Configure PIM State LimitsPUTPOSTDELETEGET
              : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
                
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

                
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

              },
              : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
                
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

              },
              : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
                
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

                
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

              },
              : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
                
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

                
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

              },
              : {
Override default maximum for number of routesPUTPOSTDELETEGET
                
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

              },
              : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
                
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

                
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

              }
            },
            
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

          }
        }
      ]
    },
    : {
Default ContextPUTPOSTDELETEGET
      : {
IPV4 commandsPUTPOSTDELETEGET
        : {
Configure Candidate-RPsPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"protocol-mode": "string", Protocol Mode

              
"ttl": "string", TTL in Hops

              
"access-list-name": "string", Access list of groups that should map to a\ngiven RP

              
"announce-period": "string", Time between discovery messages 

              
"interface-name": "string" The name of interface

            }
          ]
        },
        : {
Configure Non-stop forwarding (NSF) optionsPUTPOSTDELETEGET
          
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

        },
        : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"rpf-proxy-address": "string", RPF Proxy Address

              
"prefix-length": "string", Hash Mask Length for this candidate BSR

              
"source-address": "string" Source Address

            }
          ]
        },
        : [
Configure convergence parametersPUTPOSTDELETEGET
          {
            
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

            
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

          }
        ],
        
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
        : {
Configure RPF optionsPUTPOSTDELETEGET
          
"route-policy": "string" Route policy to select RPF topology

        },
        
"multipath": "string", Enable equal-cost multipath routing

        
"register-source": "string", Source address to use for register messages

        
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
        : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"rpf-proxy-address": "string", RPF Proxy Address

              
"prefix-length": "string", Hash Mask Length for this candidate BSR

              
"source-address": "string" Source Address

            }
          ]
        },
        
"neighbor-filter": "string", Access-list of neighbors to be filtered
        : [
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
          {
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                
"rp-address": "string", RP address of Rendezvous Point

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              }
            ]
          }
        ],
        : {
Configure AutoRP Mapping AgentPUTPOSTDELETEGET
          : {
Specifications for Mapping Agent configured\non this boxPUTPOSTDELETEGET
            
"interface-name": "string", The name of interface

            
"announce-period": "string", Time between discovery messages 

            
"ttl": "string" TTL in Hops

          },
          : {
Mapping Agent cache size limitPUTPOSTDELETEGET
            
"maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"

            
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"

          }
        },
        : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
          
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        },
        
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
        : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
          
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

          
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

        },
        : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
          
"rp-list-name": "string", Access-list specifiying applicable RPs

          
"group-list-name": "string" Access-list specifiying applicable groups

        },
        
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol

        
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
        : {
Configure RPF-redirect featurePUTPOSTDELETEGET
          
"route-policy": "string" Route policy to select RPF topology

        },
        
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
        : {
Interface-level ConfigurationPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 onlyPUTPOSTDELETEGET
                
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

                
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

                
"bundle-name": "string" Bundle name

              },
              
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

              
"interface-name": "string", The name of interface
              : {
Maximum number of PIM routesPUTPOSTDELETEGET
                
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              },
              : {
BFD configurationPUTPOSTDELETEGET
                
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

                
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

              },
              
"neighbor-filter": "string", Access-list of neighbors to be filtered

              
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

              
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

              
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

              
"interface-enable": "boolean", Enable PIM processing on the interface

              
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

              
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

              
"bsr-border": "boolean" BSR Border configuration for Interface

            }
          ]
        },
        : {
PIM BSR configurationPUTPOSTDELETEGET
          : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
            
"priority": "string", Priority of the CRP

            
"prefix-length": "string", Hash Mask Length for this candidate BSR

            
"address": "string" Address of Candidate-RP

          },
          : {
PIM RP configurationPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

                
"priority": "string", Priority of the CRP

                
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

                
"mode": "string", SM or Bidir

                
"address": "string" Address of Candidate-RP

              }
            ]
          }
        },
        : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
          
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

          
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
          : {
Clone multicast joinsPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"source": "string", Original source address (S)

                
"prefix-length": "string", Hash Mask Length for this candidate BSR

                
"backup": "string", Backup cloned address (S2)

                
"primary": "string" Primary cloned address (S1)

              }
            ]
          },
          : {
Clone multicast trafficPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"source": "string", Original source address (S)

                
"prefix-length": "string", Hash Mask Length for this candidate BSR

                
"backup": "string", Backup cloned address (S2)

                
"primary": "string" Primary cloned address (S1)

              }
            ]
          },
          
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

        },
        : {
Configure IP Multicast SSMPUTPOSTDELETEGET
          
"range": "string", Access list of groups enabled with SSM

          
"disable": "boolean" TRUE if SSM is disabled on this router

        },
        
"rp-static-deny": "string", Configure static RP deny range

        
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
        : {
Inheritable defaultsPUTPOSTDELETEGET
          
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

          
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

          
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

          
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

          
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

          
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

          
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

        },
        : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        },
        
"accept-register": "string", Access-list which specifies unauthorized sources

        
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
        : {
Configure PIM State LimitsPUTPOSTDELETEGET
          
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
          : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
            
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

            
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

          },
          : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
            
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

            
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

          },
          : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
            
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

          },
          : {
Override default maximum for number of routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

          },
          : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
            
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
            
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

          },
          
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
          : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
            
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum for number of routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

          },
          : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
            
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

          }
        },
        
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

      },
      : {
IPV6 commandsPUTPOSTDELETEGET
        : {
Configure Non-stop forwarding (NSF) optionsPUTPOSTDELETEGET
          
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

        },
        : {
Configure convergence parametersPUTPOSTDELETEGET
          
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

          
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

        },
        
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
        : {
Configure RPF optionsPUTPOSTDELETEGET
          
"route-policy": "string" Route policy to select RPF topology

        },
        
"multipath": "string", Enable equal-cost multipath routing

        
"register-source": "string", Source address to use for register messages

        
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages

        
"neighbor-filter": "string", Access-list of neighbors to be filtered
        : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        },
        
"accept-register": "string", Access-list which specifies unauthorized sources
        : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
          
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        },
        
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
        : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
          
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

          
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

        },
        : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
          
"rp-list-name": "string", Access-list specifiying applicable RPs

          
"group-list-name": "string" Access-list specifiying applicable groups

        },
        
"embedded-rp-disable": "null", Set Embedded RP processing support

        
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

        
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
        : {
Interface-level ConfigurationPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"neighbor-filter": "string", Access-list of neighbors to be filtered

              
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

              
"interface-name": "string", The name of interface
              : {
Maximum number of PIM routesPUTPOSTDELETEGET
                
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              },
              : {
BFD configurationPUTPOSTDELETEGET
                
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

                
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

              },
              
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

              
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

              
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

              
"interface-enable": "boolean", Enable PIM processing on the interface

              
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

              
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

              
"bsr-border": "boolean" BSR Border configuration for Interface

            }
          ]
        },
        : {
Set Embedded RP processing supportPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        },
        : {
PIM BSR configurationPUTPOSTDELETEGET
          : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
            
"priority": "string", Priority of the CRP

            
"prefix-length": "string", Hash Mask Length for this candidate BSR

            
"address": "string" Address of Candidate-RP

          },
          : {
PIM RP configurationPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

                
"priority": "string", Priority of the CRP

                
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

                
"mode": "string", SM or Bidir

                
"address": "string" Address of Candidate-RP

              }
            ]
          }
        },
        : {
Configure IP Multicast SSMPUTPOSTDELETEGET
          
"range": "string", Access list of groups enabled with SSM

          
"disable": "boolean" TRUE if SSM is disabled on this router

        },
        
"rp-static-deny": "string", Configure static RP deny range

        
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
        : {
Inheritable defaultsPUTPOSTDELETEGET
          
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

          
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

          
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

          
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

          
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

          
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

          
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

        },
        : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        },
        
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
        : {
Configure PIM State LimitsPUTPOSTDELETEGET
          
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
          : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
            
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

            
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

          },
          : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
            
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

            
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

          },
          : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
            
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

          },
          : {
Override default maximum for number of routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

          },
          : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
            
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
            
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

          },
          
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
          : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
            
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum for number of routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

          },
          : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
            
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

          }
        },
        
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PIM - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/

Create operation of resource: pim

pim_schema

pimbody object

Request Content-Types: application/json
Request Example
{
  : {
PIM configurationPUTPOSTDELETEGET
    : {
VRF tablePUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"vrf-name": "string", VRF name
          : {
IPV4 commandsPUTPOSTDELETEGET
            : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"rpf-proxy-address": "string", RPF Proxy Address

                  
"prefix-length": "string", Hash Mask Length for this candidate BSR

                  
"source-address": "string" Source Address

                }
              ]
            },
            : [
Configure convergence parametersPUTPOSTDELETEGET
              {
                
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

                
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

              }
            ],
            
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
            : {
Configure RPF optionsPUTPOSTDELETEGET
              
"route-policy": "string" Route policy to select RPF topology

            },
            
"multipath": "string", Enable equal-cost multipath routing

            
"register-source": "string", Source address to use for register messages

            
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
            : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"rpf-proxy-address": "string", RPF Proxy Address

                  
"prefix-length": "string", Hash Mask Length for this candidate BSR

                  
"source-address": "string" Source Address

                }
              ]
            },
            
"neighbor-filter": "string", Access-list of neighbors to be filtered
            : [
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
              {
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                    
"rp-address": "string", RP address of Rendezvous Point

                    
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                  }
                ]
              }
            ],
            
"accept-register": "string", Access-list which specifies unauthorized sources
            : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
              
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            },
            
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
            : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
              
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

              
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

            },
            : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
              
"rp-list-name": "string", Access-list specifiying applicable RPs

              
"group-list-name": "string" Access-list specifiying applicable groups

            },
            
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol

            
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

            
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
            : {
Interface-level ConfigurationPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"neighbor-filter": "string", Access-list of neighbors to be filtered

                  
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                  
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

                  
"interface-name": "string", The name of interface
                  : {
Maximum number of PIM routesPUTPOSTDELETEGET
                    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                    
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

                    
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                  },
                  : {
BFD configurationPUTPOSTDELETEGET
                    
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                    
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

                    
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

                  },
                  
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

                  
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

                  
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

                  
"interface-enable": "boolean", Enable PIM processing on the interface

                  
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

                  
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

                  
"bsr-border": "boolean" BSR Border configuration for Interface

                }
              ]
            },
            
"rp-static-deny": "string", Configure static RP deny range
            : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
              
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

              
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
              : {
Clone multicast joinsPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"source": "string", Original source address (S)

                    
"prefix-length": "string", Hash Mask Length for this candidate BSR

                    
"backup": "string", Backup cloned address (S2)

                    
"primary": "string" Primary cloned address (S1)

                  }
                ]
              },
              : {
Clone multicast trafficPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"source": "string", Original source address (S)

                    
"prefix-length": "string", Hash Mask Length for this candidate BSR

                    
"backup": "string", Backup cloned address (S2)

                    
"primary": "string" Primary cloned address (S1)

                  }
                ]
              },
              
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

            },
            : {
Configure IP Multicast SSMPUTPOSTDELETEGET
              
"range": "string", Access list of groups enabled with SSM

              
"disable": "boolean" TRUE if SSM is disabled on this router

            },
            : {
PIM BSR configurationPUTPOSTDELETEGET
              : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
                
"priority": "string", Priority of the CRP

                
"prefix-length": "string", Hash Mask Length for this candidate BSR

                
"address": "string" Address of Candidate-RP

              },
              : {
PIM RP configurationPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

                    
"priority": "string", Priority of the CRP

                    
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

                    
"mode": "string", SM or Bidir

                    
"address": "string" Address of Candidate-RP

                  }
                ]
              }
            },
            
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
            : {
Inheritable defaultsPUTPOSTDELETEGET
              
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

              
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

              
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

              
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

              
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

              
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

              
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

            },
            : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                  
"rp-address": "string", RP address of Rendezvous Point

                  
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                }
              ]
            },
            
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
            : {
Configure PIM State LimitsPUTPOSTDELETEGET
              : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
                
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

                
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

              },
              : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
                
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

              },
              : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
                
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

                
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

              },
              : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
                
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

                
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

              },
              : {
Override default maximum for number of routesPUTPOSTDELETEGET
                
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

              },
              : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
                
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

                
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

              }
            },
            
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

          },
          : {
IPV6 commandsPUTPOSTDELETEGET
            : {
Configure convergence parametersPUTPOSTDELETEGET
              
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

              
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

            },
            
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
            : {
Configure RPF optionsPUTPOSTDELETEGET
              
"route-policy": "string" Route policy to select RPF topology

            },
            
"multipath": "string", Enable equal-cost multipath routing

            
"register-source": "string", Source address to use for register messages

            
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages

            
"neighbor-filter": "string", Access-list of neighbors to be filtered
            : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                  
"rp-address": "string", RP address of Rendezvous Point

                  
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                }
              ]
            },
            
"accept-register": "string", Access-list which specifies unauthorized sources
            : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
              
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            },
            
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
            : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
              
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

              
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

            },
            : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
              
"rp-list-name": "string", Access-list specifiying applicable RPs

              
"group-list-name": "string" Access-list specifiying applicable groups

            },
            
"embedded-rp-disable": "null", Set Embedded RP processing support

            
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

            
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
            : {
Interface-level ConfigurationPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"neighbor-filter": "string", Access-list of neighbors to be filtered

                  
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                  
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

                  
"interface-name": "string", The name of interface
                  : {
Maximum number of PIM routesPUTPOSTDELETEGET
                    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                    
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

                    
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                  },
                  : {
BFD configurationPUTPOSTDELETEGET
                    
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                    
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

                    
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

                  },
                  
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

                  
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

                  
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

                  
"interface-enable": "boolean", Enable PIM processing on the interface

                  
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

                  
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

                  
"bsr-border": "boolean" BSR Border configuration for Interface

                }
              ]
            },
            : {
Set Embedded RP processing supportPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"rp-address": "string", RP address of Rendezvous Point

                  
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                }
              ]
            },
            : {
PIM BSR configurationPUTPOSTDELETEGET
              : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
                
"priority": "string", Priority of the CRP

                
"prefix-length": "string", Hash Mask Length for this candidate BSR

                
"address": "string" Address of Candidate-RP

              },
              : {
PIM RP configurationPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

                    
"priority": "string", Priority of the CRP

                    
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

                    
"mode": "string", SM or Bidir

                    
"address": "string" Address of Candidate-RP

                  }
                ]
              }
            },
            : {
Configure IP Multicast SSMPUTPOSTDELETEGET
              
"range": "string", Access list of groups enabled with SSM

              
"disable": "boolean" TRUE if SSM is disabled on this router

            },
            
"rp-static-deny": "string", Configure static RP deny range

            
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
            : {
Inheritable defaultsPUTPOSTDELETEGET
              
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

              
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

              
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

              
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

              
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

              
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

              
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

            },
            : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                  
"rp-address": "string", RP address of Rendezvous Point

                  
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                }
              ]
            },
            
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
            : {
Configure PIM State LimitsPUTPOSTDELETEGET
              : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
                
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

                
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

              },
              : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
                
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

              },
              : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
                
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

                
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

              },
              : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
                
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

                
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

              },
              : {
Override default maximum for number of routesPUTPOSTDELETEGET
                
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

              },
              : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
                
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

                
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

              }
            },
            
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

          }
        }
      ]
    },
    : {
Default ContextPUTPOSTDELETEGET
      : {
IPV4 commandsPUTPOSTDELETEGET
        : {
Configure Candidate-RPsPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"protocol-mode": "string", Protocol Mode

              
"ttl": "string", TTL in Hops

              
"access-list-name": "string", Access list of groups that should map to a\ngiven RP

              
"announce-period": "string", Time between discovery messages 

              
"interface-name": "string" The name of interface

            }
          ]
        },
        : {
Configure Non-stop forwarding (NSF) optionsPUTPOSTDELETEGET
          
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

        },
        : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"rpf-proxy-address": "string", RPF Proxy Address

              
"prefix-length": "string", Hash Mask Length for this candidate BSR

              
"source-address": "string" Source Address

            }
          ]
        },
        : [
Configure convergence parametersPUTPOSTDELETEGET
          {
            
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

            
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

          }
        ],
        
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
        : {
Configure RPF optionsPUTPOSTDELETEGET
          
"route-policy": "string" Route policy to select RPF topology

        },
        
"multipath": "string", Enable equal-cost multipath routing

        
"register-source": "string", Source address to use for register messages

        
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
        : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"rpf-proxy-address": "string", RPF Proxy Address

              
"prefix-length": "string", Hash Mask Length for this candidate BSR

              
"source-address": "string" Source Address

            }
          ]
        },
        
"neighbor-filter": "string", Access-list of neighbors to be filtered
        : [
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
          {
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                
"rp-address": "string", RP address of Rendezvous Point

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              }
            ]
          }
        ],
        : {
Configure AutoRP Mapping AgentPUTPOSTDELETEGET
          : {
Specifications for Mapping Agent configured\non this boxPUTPOSTDELETEGET
            
"interface-name": "string", The name of interface

            
"announce-period": "string", Time between discovery messages 

            
"ttl": "string" TTL in Hops

          },
          : {
Mapping Agent cache size limitPUTPOSTDELETEGET
            
"maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"

            
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"

          }
        },
        : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
          
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        },
        
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
        : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
          
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

          
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

        },
        : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
          
"rp-list-name": "string", Access-list specifiying applicable RPs

          
"group-list-name": "string" Access-list specifiying applicable groups

        },
        
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol

        
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
        : {
Configure RPF-redirect featurePUTPOSTDELETEGET
          
"route-policy": "string" Route policy to select RPF topology

        },
        
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
        : {
Interface-level ConfigurationPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 onlyPUTPOSTDELETEGET
                
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

                
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

                
"bundle-name": "string" Bundle name

              },
              
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

              
"interface-name": "string", The name of interface
              : {
Maximum number of PIM routesPUTPOSTDELETEGET
                
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              },
              : {
BFD configurationPUTPOSTDELETEGET
                
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

                
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

              },
              
"neighbor-filter": "string", Access-list of neighbors to be filtered

              
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

              
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

              
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

              
"interface-enable": "boolean", Enable PIM processing on the interface

              
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

              
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

              
"bsr-border": "boolean" BSR Border configuration for Interface

            }
          ]
        },
        : {
PIM BSR configurationPUTPOSTDELETEGET
          : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
            
"priority": "string", Priority of the CRP

            
"prefix-length": "string", Hash Mask Length for this candidate BSR

            
"address": "string" Address of Candidate-RP

          },
          : {
PIM RP configurationPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

                
"priority": "string", Priority of the CRP

                
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

                
"mode": "string", SM or Bidir

                
"address": "string" Address of Candidate-RP

              }
            ]
          }
        },
        : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
          
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

          
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
          : {
Clone multicast joinsPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"source": "string", Original source address (S)

                
"prefix-length": "string", Hash Mask Length for this candidate BSR

                
"backup": "string", Backup cloned address (S2)

                
"primary": "string" Primary cloned address (S1)

              }
            ]
          },
          : {
Clone multicast trafficPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"source": "string", Original source address (S)

                
"prefix-length": "string", Hash Mask Length for this candidate BSR

                
"backup": "string", Backup cloned address (S2)

                
"primary": "string" Primary cloned address (S1)

              }
            ]
          },
          
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

        },
        : {
Configure IP Multicast SSMPUTPOSTDELETEGET
          
"range": "string", Access list of groups enabled with SSM

          
"disable": "boolean" TRUE if SSM is disabled on this router

        },
        
"rp-static-deny": "string", Configure static RP deny range

        
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
        : {
Inheritable defaultsPUTPOSTDELETEGET
          
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

          
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

          
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

          
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

          
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

          
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

          
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

        },
        : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        },
        
"accept-register": "string", Access-list which specifies unauthorized sources

        
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
        : {
Configure PIM State LimitsPUTPOSTDELETEGET
          
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
          : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
            
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

            
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

          },
          : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
            
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

            
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

          },
          : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
            
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

          },
          : {
Override default maximum for number of routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

          },
          : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
            
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
            
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

          },
          
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
          : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
            
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum for number of routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

          },
          : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
            
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

          }
        },
        
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

      },
      : {
IPV6 commandsPUTPOSTDELETEGET
        : {
Configure Non-stop forwarding (NSF) optionsPUTPOSTDELETEGET
          
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

        },
        : {
Configure convergence parametersPUTPOSTDELETEGET
          
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

          
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

        },
        
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
        : {
Configure RPF optionsPUTPOSTDELETEGET
          
"route-policy": "string" Route policy to select RPF topology

        },
        
"multipath": "string", Enable equal-cost multipath routing

        
"register-source": "string", Source address to use for register messages

        
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages

        
"neighbor-filter": "string", Access-list of neighbors to be filtered
        : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        },
        
"accept-register": "string", Access-list which specifies unauthorized sources
        : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
          
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        },
        
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
        : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
          
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

          
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

        },
        : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
          
"rp-list-name": "string", Access-list specifiying applicable RPs

          
"group-list-name": "string" Access-list specifiying applicable groups

        },
        
"embedded-rp-disable": "null", Set Embedded RP processing support

        
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

        
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
        : {
Interface-level ConfigurationPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"neighbor-filter": "string", Access-list of neighbors to be filtered

              
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

              
"interface-name": "string", The name of interface
              : {
Maximum number of PIM routesPUTPOSTDELETEGET
                
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              },
              : {
BFD configurationPUTPOSTDELETEGET
                
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

                
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

              },
              
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

              
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

              
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

              
"interface-enable": "boolean", Enable PIM processing on the interface

              
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

              
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

              
"bsr-border": "boolean" BSR Border configuration for Interface

            }
          ]
        },
        : {
Set Embedded RP processing supportPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        },
        : {
PIM BSR configurationPUTPOSTDELETEGET
          : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
            
"priority": "string", Priority of the CRP

            
"prefix-length": "string", Hash Mask Length for this candidate BSR

            
"address": "string" Address of Candidate-RP

          },
          : {
PIM RP configurationPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

                
"priority": "string", Priority of the CRP

                
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

                
"mode": "string", SM or Bidir

                
"address": "string" Address of Candidate-RP

              }
            ]
          }
        },
        : {
Configure IP Multicast SSMPUTPOSTDELETEGET
          
"range": "string", Access list of groups enabled with SSM

          
"disable": "boolean" TRUE if SSM is disabled on this router

        },
        
"rp-static-deny": "string", Configure static RP deny range

        
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
        : {
Inheritable defaultsPUTPOSTDELETEGET
          
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

          
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

          
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

          
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

          
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

          
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

          
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

        },
        : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        },
        
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
        : {
Configure PIM State LimitsPUTPOSTDELETEGET
          
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
          : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
            
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

            
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

          },
          : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
            
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

            
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

          },
          : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
            
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

          },
          : {
Override default maximum for number of routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

          },
          : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
            
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
            
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

          },
          
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
          : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
            
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum for number of routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

          },
          : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
            
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

          }
        },
        
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PIM - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/

Delete operation of resource: pim

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PIM - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/

Retrieve operation of resource: pim

200 OK
pim_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
PIM configurationPUTPOSTDELETEGET
    : {
VRF tablePUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"vrf-name": "string", VRF name
          : {
IPV4 commandsPUTPOSTDELETEGET
            : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"rpf-proxy-address": "string", RPF Proxy Address

                  
"prefix-length": "string", Hash Mask Length for this candidate BSR

                  
"source-address": "string" Source Address

                }
              ]
            },
            : [
Configure convergence parametersPUTPOSTDELETEGET
              {
                
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

                
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

              }
            ],
            
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
            : {
Configure RPF optionsPUTPOSTDELETEGET
              
"route-policy": "string" Route policy to select RPF topology

            },
            
"multipath": "string", Enable equal-cost multipath routing

            
"register-source": "string", Source address to use for register messages

            
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
            : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"rpf-proxy-address": "string", RPF Proxy Address

                  
"prefix-length": "string", Hash Mask Length for this candidate BSR

                  
"source-address": "string" Source Address

                }
              ]
            },
            
"neighbor-filter": "string", Access-list of neighbors to be filtered
            : [
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
              {
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                    
"rp-address": "string", RP address of Rendezvous Point

                    
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                  }
                ]
              }
            ],
            
"accept-register": "string", Access-list which specifies unauthorized sources
            : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
              
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            },
            
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
            : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
              
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

              
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

            },
            : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
              
"rp-list-name": "string", Access-list specifiying applicable RPs

              
"group-list-name": "string" Access-list specifiying applicable groups

            },
            
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol

            
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

            
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
            : {
Interface-level ConfigurationPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"neighbor-filter": "string", Access-list of neighbors to be filtered

                  
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                  
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

                  
"interface-name": "string", The name of interface
                  : {
Maximum number of PIM routesPUTPOSTDELETEGET
                    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                    
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

                    
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                  },
                  : {
BFD configurationPUTPOSTDELETEGET
                    
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                    
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

                    
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

                  },
                  
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

                  
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

                  
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

                  
"interface-enable": "boolean", Enable PIM processing on the interface

                  
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

                  
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

                  
"bsr-border": "boolean" BSR Border configuration for Interface

                }
              ]
            },
            
"rp-static-deny": "string", Configure static RP deny range
            : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
              
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

              
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
              : {
Clone multicast joinsPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"source": "string", Original source address (S)

                    
"prefix-length": "string", Hash Mask Length for this candidate BSR

                    
"backup": "string", Backup cloned address (S2)

                    
"primary": "string" Primary cloned address (S1)

                  }
                ]
              },
              : {
Clone multicast trafficPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"source": "string", Original source address (S)

                    
"prefix-length": "string", Hash Mask Length for this candidate BSR

                    
"backup": "string", Backup cloned address (S2)

                    
"primary": "string" Primary cloned address (S1)

                  }
                ]
              },
              
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

            },
            : {
Configure IP Multicast SSMPUTPOSTDELETEGET
              
"range": "string", Access list of groups enabled with SSM

              
"disable": "boolean" TRUE if SSM is disabled on this router

            },
            : {
PIM BSR configurationPUTPOSTDELETEGET
              : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
                
"priority": "string", Priority of the CRP

                
"prefix-length": "string", Hash Mask Length for this candidate BSR

                
"address": "string" Address of Candidate-RP

              },
              : {
PIM RP configurationPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

                    
"priority": "string", Priority of the CRP

                    
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

                    
"mode": "string", SM or Bidir

                    
"address": "string" Address of Candidate-RP

                  }
                ]
              }
            },
            
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
            : {
Inheritable defaultsPUTPOSTDELETEGET
              
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

              
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

              
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

              
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

              
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

              
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

              
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

            },
            : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                  
"rp-address": "string", RP address of Rendezvous Point

                  
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                }
              ]
            },
            
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
            : {
Configure PIM State LimitsPUTPOSTDELETEGET
              : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
                
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

                
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

              },
              : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
                
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

              },
              : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
                
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

                
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

              },
              : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
                
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

                
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

              },
              : {
Override default maximum for number of routesPUTPOSTDELETEGET
                
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

              },
              : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
                
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

                
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

              }
            },
            
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

          },
          : {
IPV6 commandsPUTPOSTDELETEGET
            : {
Configure convergence parametersPUTPOSTDELETEGET
              
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

              
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

            },
            
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
            : {
Configure RPF optionsPUTPOSTDELETEGET
              
"route-policy": "string" Route policy to select RPF topology

            },
            
"multipath": "string", Enable equal-cost multipath routing

            
"register-source": "string", Source address to use for register messages

            
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages

            
"neighbor-filter": "string", Access-list of neighbors to be filtered
            : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                  
"rp-address": "string", RP address of Rendezvous Point

                  
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                }
              ]
            },
            
"accept-register": "string", Access-list which specifies unauthorized sources
            : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
              
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            },
            
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
            : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
              
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

              
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

            },
            : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
              
"rp-list-name": "string", Access-list specifiying applicable RPs

              
"group-list-name": "string" Access-list specifiying applicable groups

            },
            
"embedded-rp-disable": "null", Set Embedded RP processing support

            
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

            
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
            : {
Interface-level ConfigurationPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"neighbor-filter": "string", Access-list of neighbors to be filtered

                  
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                  
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

                  
"interface-name": "string", The name of interface
                  : {
Maximum number of PIM routesPUTPOSTDELETEGET
                    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                    
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

                    
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                  },
                  : {
BFD configurationPUTPOSTDELETEGET
                    
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                    
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

                    
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

                  },
                  
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

                  
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

                  
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

                  
"interface-enable": "boolean", Enable PIM processing on the interface

                  
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

                  
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

                  
"bsr-border": "boolean" BSR Border configuration for Interface

                }
              ]
            },
            : {
Set Embedded RP processing supportPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"rp-address": "string", RP address of Rendezvous Point

                  
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                }
              ]
            },
            : {
PIM BSR configurationPUTPOSTDELETEGET
              : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
                
"priority": "string", Priority of the CRP

                
"prefix-length": "string", Hash Mask Length for this candidate BSR

                
"address": "string" Address of Candidate-RP

              },
              : {
PIM RP configurationPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

                    
"priority": "string", Priority of the CRP

                    
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

                    
"mode": "string", SM or Bidir

                    
"address": "string" Address of Candidate-RP

                  }
                ]
              }
            },
            : {
Configure IP Multicast SSMPUTPOSTDELETEGET
              
"range": "string", Access list of groups enabled with SSM

              
"disable": "boolean" TRUE if SSM is disabled on this router

            },
            
"rp-static-deny": "string", Configure static RP deny range

            
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
            : {
Inheritable defaultsPUTPOSTDELETEGET
              
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

              
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

              
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

              
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

              
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

              
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

              
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

            },
            : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                  
"rp-address": "string", RP address of Rendezvous Point

                  
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                }
              ]
            },
            
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
            : {
Configure PIM State LimitsPUTPOSTDELETEGET
              : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
                
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

                
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

              },
              : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
                
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

              },
              : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
                
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

                
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

              },
              : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
                
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

                
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

              },
              : {
Override default maximum for number of routesPUTPOSTDELETEGET
                
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

              },
              : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
                
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

                
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

              }
            },
            
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

          }
        }
      ]
    },
    : {
Default ContextPUTPOSTDELETEGET
      : {
IPV4 commandsPUTPOSTDELETEGET
        : {
Configure Candidate-RPsPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"protocol-mode": "string", Protocol Mode

              
"ttl": "string", TTL in Hops

              
"access-list-name": "string", Access list of groups that should map to a\ngiven RP

              
"announce-period": "string", Time between discovery messages 

              
"interface-name": "string" The name of interface

            }
          ]
        },
        : {
Configure Non-stop forwarding (NSF) optionsPUTPOSTDELETEGET
          
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

        },
        : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"rpf-proxy-address": "string", RPF Proxy Address

              
"prefix-length": "string", Hash Mask Length for this candidate BSR

              
"source-address": "string" Source Address

            }
          ]
        },
        : [
Configure convergence parametersPUTPOSTDELETEGET
          {
            
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

            
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

          }
        ],
        
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
        : {
Configure RPF optionsPUTPOSTDELETEGET
          
"route-policy": "string" Route policy to select RPF topology

        },
        
"multipath": "string", Enable equal-cost multipath routing

        
"register-source": "string", Source address to use for register messages

        
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
        : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"rpf-proxy-address": "string", RPF Proxy Address

              
"prefix-length": "string", Hash Mask Length for this candidate BSR

              
"source-address": "string" Source Address

            }
          ]
        },
        
"neighbor-filter": "string", Access-list of neighbors to be filtered
        : [
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
          {
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                
"rp-address": "string", RP address of Rendezvous Point

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              }
            ]
          }
        ],
        : {
Configure AutoRP Mapping AgentPUTPOSTDELETEGET
          : {
Specifications for Mapping Agent configured\non this boxPUTPOSTDELETEGET
            
"interface-name": "string", The name of interface

            
"announce-period": "string", Time between discovery messages 

            
"ttl": "string" TTL in Hops

          },
          : {
Mapping Agent cache size limitPUTPOSTDELETEGET
            
"maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"

            
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"

          }
        },
        : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
          
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        },
        
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
        : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
          
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

          
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

        },
        : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
          
"rp-list-name": "string", Access-list specifiying applicable RPs

          
"group-list-name": "string" Access-list specifiying applicable groups

        },
        
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol

        
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
        : {
Configure RPF-redirect featurePUTPOSTDELETEGET
          
"route-policy": "string" Route policy to select RPF topology

        },
        
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
        : {
Interface-level ConfigurationPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 onlyPUTPOSTDELETEGET
                
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

                
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

                
"bundle-name": "string" Bundle name

              },
              
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

              
"interface-name": "string", The name of interface
              : {
Maximum number of PIM routesPUTPOSTDELETEGET
                
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              },
              : {
BFD configurationPUTPOSTDELETEGET
                
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

                
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

              },
              
"neighbor-filter": "string", Access-list of neighbors to be filtered

              
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

              
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

              
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

              
"interface-enable": "boolean", Enable PIM processing on the interface

              
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

              
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

              
"bsr-border": "boolean" BSR Border configuration for Interface

            }
          ]
        },
        : {
PIM BSR configurationPUTPOSTDELETEGET
          : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
            
"priority": "string", Priority of the CRP

            
"prefix-length": "string", Hash Mask Length for this candidate BSR

            
"address": "string" Address of Candidate-RP

          },
          : {
PIM RP configurationPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

                
"priority": "string", Priority of the CRP

                
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

                
"mode": "string", SM or Bidir

                
"address": "string" Address of Candidate-RP

              }
            ]
          }
        },
        : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
          
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

          
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
          : {
Clone multicast joinsPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"source": "string", Original source address (S)

                
"prefix-length": "string", Hash Mask Length for this candidate BSR

                
"backup": "string", Backup cloned address (S2)

                
"primary": "string" Primary cloned address (S1)

              }
            ]
          },
          : {
Clone multicast trafficPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"source": "string", Original source address (S)

                
"prefix-length": "string", Hash Mask Length for this candidate BSR

                
"backup": "string", Backup cloned address (S2)

                
"primary": "string" Primary cloned address (S1)

              }
            ]
          },
          
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

        },
        : {
Configure IP Multicast SSMPUTPOSTDELETEGET
          
"range": "string", Access list of groups enabled with SSM

          
"disable": "boolean" TRUE if SSM is disabled on this router

        },
        
"rp-static-deny": "string", Configure static RP deny range

        
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
        : {
Inheritable defaultsPUTPOSTDELETEGET
          
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

          
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

          
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

          
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

          
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

          
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

          
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

        },
        : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        },
        
"accept-register": "string", Access-list which specifies unauthorized sources

        
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
        : {
Configure PIM State LimitsPUTPOSTDELETEGET
          
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
          : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
            
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

            
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

          },
          : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
            
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

            
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

          },
          : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
            
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

          },
          : {
Override default maximum for number of routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

          },
          : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
            
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
            
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

          },
          
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
          : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
            
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum for number of routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

          },
          : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
            
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

          }
        },
        
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

      },
      : {
IPV6 commandsPUTPOSTDELETEGET
        : {
Configure Non-stop forwarding (NSF) optionsPUTPOSTDELETEGET
          
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

        },
        : {
Configure convergence parametersPUTPOSTDELETEGET
          
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

          
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

        },
        
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
        : {
Configure RPF optionsPUTPOSTDELETEGET
          
"route-policy": "string" Route policy to select RPF topology

        },
        
"multipath": "string", Enable equal-cost multipath routing

        
"register-source": "string", Source address to use for register messages

        
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages

        
"neighbor-filter": "string", Access-list of neighbors to be filtered
        : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        },
        
"accept-register": "string", Access-list which specifies unauthorized sources
        : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
          
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        },
        
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
        : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
          
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

          
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

        },
        : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
          
"rp-list-name": "string", Access-list specifiying applicable RPs

          
"group-list-name": "string" Access-list specifiying applicable groups

        },
        
"embedded-rp-disable": "null", Set Embedded RP processing support

        
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

        
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
        : {
Interface-level ConfigurationPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"neighbor-filter": "string", Access-list of neighbors to be filtered

              
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

              
"interface-name": "string", The name of interface
              : {
Maximum number of PIM routesPUTPOSTDELETEGET
                
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              },
              : {
BFD configurationPUTPOSTDELETEGET
                
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

                
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

              },
              
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

              
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

              
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

              
"interface-enable": "boolean", Enable PIM processing on the interface

              
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

              
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

              
"bsr-border": "boolean" BSR Border configuration for Interface

            }
          ]
        },
        : {
Set Embedded RP processing supportPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        },
        : {
PIM BSR configurationPUTPOSTDELETEGET
          : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
            
"priority": "string", Priority of the CRP

            
"prefix-length": "string", Hash Mask Length for this candidate BSR

            
"address": "string" Address of Candidate-RP

          },
          : {
PIM RP configurationPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

                
"priority": "string", Priority of the CRP

                
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

                
"mode": "string", SM or Bidir

                
"address": "string" Address of Candidate-RP

              }
            ]
          }
        },
        : {
Configure IP Multicast SSMPUTPOSTDELETEGET
          
"range": "string", Access list of groups enabled with SSM

          
"disable": "boolean" TRUE if SSM is disabled on this router

        },
        
"rp-static-deny": "string", Configure static RP deny range

        
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
        : {
Inheritable defaultsPUTPOSTDELETEGET
          
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

          
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

          
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

          
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

          
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

          
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

          
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

        },
        : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        },
        
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
        : {
Configure PIM State LimitsPUTPOSTDELETEGET
          
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
          : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
            
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

            
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

          },
          : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
            
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

            
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

          },
          : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
            
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

          },
          : {
Override default maximum for number of routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

          },
          : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
            
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
            
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

          },
          
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
          : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
            
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum for number of routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

          },
          : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
            
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

          }
        },
        
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

      }
    }
  }
}

VRFS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/

Update operation of resource: vrfs

vrfs_schema

vrfsbody object

Request Content-Types: application/json
Request Example
{
  : {
VRF tablePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"vrf-name": "string", VRF name
        : {
IPV4 commandsPUTPOSTDELETEGET
          : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"rpf-proxy-address": "string", RPF Proxy Address

                
"prefix-length": "string", Hash Mask Length for this candidate BSR

                
"source-address": "string" Source Address

              }
            ]
          },
          : [
Configure convergence parametersPUTPOSTDELETEGET
            {
              
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

              
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

            }
          ],
          
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
          : {
Configure RPF optionsPUTPOSTDELETEGET
            
"route-policy": "string" Route policy to select RPF topology

          },
          
"multipath": "string", Enable equal-cost multipath routing

          
"register-source": "string", Source address to use for register messages

          
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
          : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"rpf-proxy-address": "string", RPF Proxy Address

                
"prefix-length": "string", Hash Mask Length for this candidate BSR

                
"source-address": "string" Source Address

              }
            ]
          },
          
"neighbor-filter": "string", Access-list of neighbors to be filtered
          : [
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
            {
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                  
"rp-address": "string", RP address of Rendezvous Point

                  
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                }
              ]
            }
          ],
          
"accept-register": "string", Access-list which specifies unauthorized sources
          : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
            
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          },
          
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
          : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
            
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

            
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

            
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

          },
          : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
            
"rp-list-name": "string", Access-list specifiying applicable RPs

            
"group-list-name": "string" Access-list specifiying applicable groups

          },
          
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol

          
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

          
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
          : {
Interface-level ConfigurationPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"neighbor-filter": "string", Access-list of neighbors to be filtered

                
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

                
"interface-name": "string", The name of interface
                : {
Maximum number of PIM routesPUTPOSTDELETEGET
                  
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                  
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

                  
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                },
                : {
BFD configurationPUTPOSTDELETEGET
                  
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                  
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

                  
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

                },
                
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

                
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

                
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

                
"interface-enable": "boolean", Enable PIM processing on the interface

                
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

                
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

                
"bsr-border": "boolean" BSR Border configuration for Interface

              }
            ]
          },
          
"rp-static-deny": "string", Configure static RP deny range
          : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
            
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

            
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

            
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
            : {
Clone multicast joinsPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"source": "string", Original source address (S)

                  
"prefix-length": "string", Hash Mask Length for this candidate BSR

                  
"backup": "string", Backup cloned address (S2)

                  
"primary": "string" Primary cloned address (S1)

                }
              ]
            },
            : {
Clone multicast trafficPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"source": "string", Original source address (S)

                  
"prefix-length": "string", Hash Mask Length for this candidate BSR

                  
"backup": "string", Backup cloned address (S2)

                  
"primary": "string" Primary cloned address (S1)

                }
              ]
            },
            
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

          },
          : {
Configure IP Multicast SSMPUTPOSTDELETEGET
            
"range": "string", Access list of groups enabled with SSM

            
"disable": "boolean" TRUE if SSM is disabled on this router

          },
          : {
PIM BSR configurationPUTPOSTDELETEGET
            : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
              
"priority": "string", Priority of the CRP

              
"prefix-length": "string", Hash Mask Length for this candidate BSR

              
"address": "string" Address of Candidate-RP

            },
            : {
PIM RP configurationPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

                  
"priority": "string", Priority of the CRP

                  
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

                  
"mode": "string", SM or Bidir

                  
"address": "string" Address of Candidate-RP

                }
              ]
            }
          },
          
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
          : {
Inheritable defaultsPUTPOSTDELETEGET
            
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

            
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

            
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

            
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

            
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

            
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

            
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

          },
          : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                
"rp-address": "string", RP address of Rendezvous Point

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              }
            ]
          },
          
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
          : {
Configure PIM State LimitsPUTPOSTDELETEGET
            : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
              
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

              
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

            },
            : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
              
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

              
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

            },
            : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
              
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

              
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

            },
            : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
              
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

              
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

            },
            : {
Override default maximum for number of routesPUTPOSTDELETEGET
              
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

              
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

            },
            : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
              
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

              
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

            }
          },
          
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

        },
        : {
IPV6 commandsPUTPOSTDELETEGET
          : {
Configure convergence parametersPUTPOSTDELETEGET
            
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

            
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

          },
          
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
          : {
Configure RPF optionsPUTPOSTDELETEGET
            
"route-policy": "string" Route policy to select RPF topology

          },
          
"multipath": "string", Enable equal-cost multipath routing

          
"register-source": "string", Source address to use for register messages

          
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages

          
"neighbor-filter": "string", Access-list of neighbors to be filtered
          : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                
"rp-address": "string", RP address of Rendezvous Point

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              }
            ]
          },
          
"accept-register": "string", Access-list which specifies unauthorized sources
          : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
            
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          },
          
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
          : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
            
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

            
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

            
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

          },
          : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
            
"rp-list-name": "string", Access-list specifiying applicable RPs

            
"group-list-name": "string" Access-list specifiying applicable groups

          },
          
"embedded-rp-disable": "null", Set Embedded RP processing support

          
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

          
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
          : {
Interface-level ConfigurationPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"neighbor-filter": "string", Access-list of neighbors to be filtered

                
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

                
"interface-name": "string", The name of interface
                : {
Maximum number of PIM routesPUTPOSTDELETEGET
                  
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                  
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

                  
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                },
                : {
BFD configurationPUTPOSTDELETEGET
                  
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                  
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

                  
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

                },
                
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

                
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

                
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

                
"interface-enable": "boolean", Enable PIM processing on the interface

                
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

                
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

                
"bsr-border": "boolean" BSR Border configuration for Interface

              }
            ]
          },
          : {
Set Embedded RP processing supportPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"rp-address": "string", RP address of Rendezvous Point

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              }
            ]
          },
          : {
PIM BSR configurationPUTPOSTDELETEGET
            : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
              
"priority": "string", Priority of the CRP

              
"prefix-length": "string", Hash Mask Length for this candidate BSR

              
"address": "string" Address of Candidate-RP

            },
            : {
PIM RP configurationPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

                  
"priority": "string", Priority of the CRP

                  
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

                  
"mode": "string", SM or Bidir

                  
"address": "string" Address of Candidate-RP

                }
              ]
            }
          },
          : {
Configure IP Multicast SSMPUTPOSTDELETEGET
            
"range": "string", Access list of groups enabled with SSM

            
"disable": "boolean" TRUE if SSM is disabled on this router

          },
          
"rp-static-deny": "string", Configure static RP deny range

          
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
          : {
Inheritable defaultsPUTPOSTDELETEGET
            
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

            
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

            
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

            
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

            
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

            
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

            
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

          },
          : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                
"rp-address": "string", RP address of Rendezvous Point

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              }
            ]
          },
          
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
          : {
Configure PIM State LimitsPUTPOSTDELETEGET
            : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
              
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

              
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

            },
            : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
              
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

              
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

            },
            : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
              
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

              
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

            },
            : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
              
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

              
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

            },
            : {
Override default maximum for number of routesPUTPOSTDELETEGET
              
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

              
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

            },
            : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
              
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

              
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

            }
          },
          
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/

Create operation of resource: vrfs

vrfs_schema

vrfsbody object

Request Content-Types: application/json
Request Example
{
  : {
VRF tablePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"vrf-name": "string", VRF name
        : {
IPV4 commandsPUTPOSTDELETEGET
          : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"rpf-proxy-address": "string", RPF Proxy Address

                
"prefix-length": "string", Hash Mask Length for this candidate BSR

                
"source-address": "string" Source Address

              }
            ]
          },
          : [
Configure convergence parametersPUTPOSTDELETEGET
            {
              
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

              
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

            }
          ],
          
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
          : {
Configure RPF optionsPUTPOSTDELETEGET
            
"route-policy": "string" Route policy to select RPF topology

          },
          
"multipath": "string", Enable equal-cost multipath routing

          
"register-source": "string", Source address to use for register messages

          
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
          : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"rpf-proxy-address": "string", RPF Proxy Address

                
"prefix-length": "string", Hash Mask Length for this candidate BSR

                
"source-address": "string" Source Address

              }
            ]
          },
          
"neighbor-filter": "string", Access-list of neighbors to be filtered
          : [
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
            {
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                  
"rp-address": "string", RP address of Rendezvous Point

                  
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                }
              ]
            }
          ],
          
"accept-register": "string", Access-list which specifies unauthorized sources
          : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
            
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          },
          
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
          : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
            
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

            
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

            
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

          },
          : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
            
"rp-list-name": "string", Access-list specifiying applicable RPs

            
"group-list-name": "string" Access-list specifiying applicable groups

          },
          
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol

          
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

          
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
          : {
Interface-level ConfigurationPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"neighbor-filter": "string", Access-list of neighbors to be filtered

                
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

                
"interface-name": "string", The name of interface
                : {
Maximum number of PIM routesPUTPOSTDELETEGET
                  
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                  
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

                  
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                },
                : {
BFD configurationPUTPOSTDELETEGET
                  
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                  
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

                  
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

                },
                
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

                
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

                
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

                
"interface-enable": "boolean", Enable PIM processing on the interface

                
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

                
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

                
"bsr-border": "boolean" BSR Border configuration for Interface

              }
            ]
          },
          
"rp-static-deny": "string", Configure static RP deny range
          : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
            
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

            
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

            
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
            : {
Clone multicast joinsPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"source": "string", Original source address (S)

                  
"prefix-length": "string", Hash Mask Length for this candidate BSR

                  
"backup": "string", Backup cloned address (S2)

                  
"primary": "string" Primary cloned address (S1)

                }
              ]
            },
            : {
Clone multicast trafficPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"source": "string", Original source address (S)

                  
"prefix-length": "string", Hash Mask Length for this candidate BSR

                  
"backup": "string", Backup cloned address (S2)

                  
"primary": "string" Primary cloned address (S1)

                }
              ]
            },
            
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

          },
          : {
Configure IP Multicast SSMPUTPOSTDELETEGET
            
"range": "string", Access list of groups enabled with SSM

            
"disable": "boolean" TRUE if SSM is disabled on this router

          },
          : {
PIM BSR configurationPUTPOSTDELETEGET
            : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
              
"priority": "string", Priority of the CRP

              
"prefix-length": "string", Hash Mask Length for this candidate BSR

              
"address": "string" Address of Candidate-RP

            },
            : {
PIM RP configurationPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

                  
"priority": "string", Priority of the CRP

                  
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

                  
"mode": "string", SM or Bidir

                  
"address": "string" Address of Candidate-RP

                }
              ]
            }
          },
          
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
          : {
Inheritable defaultsPUTPOSTDELETEGET
            
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

            
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

            
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

            
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

            
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

            
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

            
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

          },
          : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                
"rp-address": "string", RP address of Rendezvous Point

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              }
            ]
          },
          
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
          : {
Configure PIM State LimitsPUTPOSTDELETEGET
            : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
              
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

              
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

            },
            : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
              
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

              
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

            },
            : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
              
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

              
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

            },
            : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
              
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

              
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

            },
            : {
Override default maximum for number of routesPUTPOSTDELETEGET
              
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

              
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

            },
            : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
              
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

              
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

            }
          },
          
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

        },
        : {
IPV6 commandsPUTPOSTDELETEGET
          : {
Configure convergence parametersPUTPOSTDELETEGET
            
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

            
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

          },
          
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
          : {
Configure RPF optionsPUTPOSTDELETEGET
            
"route-policy": "string" Route policy to select RPF topology

          },
          
"multipath": "string", Enable equal-cost multipath routing

          
"register-source": "string", Source address to use for register messages

          
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages

          
"neighbor-filter": "string", Access-list of neighbors to be filtered
          : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                
"rp-address": "string", RP address of Rendezvous Point

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              }
            ]
          },
          
"accept-register": "string", Access-list which specifies unauthorized sources
          : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
            
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          },
          
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
          : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
            
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

            
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

            
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

          },
          : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
            
"rp-list-name": "string", Access-list specifiying applicable RPs

            
"group-list-name": "string" Access-list specifiying applicable groups

          },
          
"embedded-rp-disable": "null", Set Embedded RP processing support

          
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

          
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
          : {
Interface-level ConfigurationPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"neighbor-filter": "string", Access-list of neighbors to be filtered

                
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

                
"interface-name": "string", The name of interface
                : {
Maximum number of PIM routesPUTPOSTDELETEGET
                  
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                  
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

                  
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                },
                : {
BFD configurationPUTPOSTDELETEGET
                  
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                  
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

                  
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

                },
                
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

                
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

                
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

                
"interface-enable": "boolean", Enable PIM processing on the interface

                
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

                
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

                
"bsr-border": "boolean" BSR Border configuration for Interface

              }
            ]
          },
          : {
Set Embedded RP processing supportPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"rp-address": "string", RP address of Rendezvous Point

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              }
            ]
          },
          : {
PIM BSR configurationPUTPOSTDELETEGET
            : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
              
"priority": "string", Priority of the CRP

              
"prefix-length": "string", Hash Mask Length for this candidate BSR

              
"address": "string" Address of Candidate-RP

            },
            : {
PIM RP configurationPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

                  
"priority": "string", Priority of the CRP

                  
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

                  
"mode": "string", SM or Bidir

                  
"address": "string" Address of Candidate-RP

                }
              ]
            }
          },
          : {
Configure IP Multicast SSMPUTPOSTDELETEGET
            
"range": "string", Access list of groups enabled with SSM

            
"disable": "boolean" TRUE if SSM is disabled on this router

          },
          
"rp-static-deny": "string", Configure static RP deny range

          
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
          : {
Inheritable defaultsPUTPOSTDELETEGET
            
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

            
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

            
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

            
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

            
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

            
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

            
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

          },
          : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                
"rp-address": "string", RP address of Rendezvous Point

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              }
            ]
          },
          
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
          : {
Configure PIM State LimitsPUTPOSTDELETEGET
            : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
              
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

              
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

            },
            : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
              
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

              
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

            },
            : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
              
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

              
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

            },
            : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
              
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

              
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

            },
            : {
Override default maximum for number of routesPUTPOSTDELETEGET
              
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

              
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

            },
            : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
              
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

              
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

            }
          },
          
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/

Delete operation of resource: vrfs

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/

Retrieve operation of resource: vrfs

200 OK
vrfs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
VRF tablePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"vrf-name": "string", VRF name
        : {
IPV4 commandsPUTPOSTDELETEGET
          : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"rpf-proxy-address": "string", RPF Proxy Address

                
"prefix-length": "string", Hash Mask Length for this candidate BSR

                
"source-address": "string" Source Address

              }
            ]
          },
          : [
Configure convergence parametersPUTPOSTDELETEGET
            {
              
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

              
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

            }
          ],
          
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
          : {
Configure RPF optionsPUTPOSTDELETEGET
            
"route-policy": "string" Route policy to select RPF topology

          },
          
"multipath": "string", Enable equal-cost multipath routing

          
"register-source": "string", Source address to use for register messages

          
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
          : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"rpf-proxy-address": "string", RPF Proxy Address

                
"prefix-length": "string", Hash Mask Length for this candidate BSR

                
"source-address": "string" Source Address

              }
            ]
          },
          
"neighbor-filter": "string", Access-list of neighbors to be filtered
          : [
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
            {
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                  
"rp-address": "string", RP address of Rendezvous Point

                  
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                }
              ]
            }
          ],
          
"accept-register": "string", Access-list which specifies unauthorized sources
          : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
            
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          },
          
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
          : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
            
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

            
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

            
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

          },
          : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
            
"rp-list-name": "string", Access-list specifiying applicable RPs

            
"group-list-name": "string" Access-list specifiying applicable groups

          },
          
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol

          
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

          
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
          : {
Interface-level ConfigurationPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"neighbor-filter": "string", Access-list of neighbors to be filtered

                
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

                
"interface-name": "string", The name of interface
                : {
Maximum number of PIM routesPUTPOSTDELETEGET
                  
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                  
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

                  
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                },
                : {
BFD configurationPUTPOSTDELETEGET
                  
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                  
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

                  
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

                },
                
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

                
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

                
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

                
"interface-enable": "boolean", Enable PIM processing on the interface

                
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

                
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

                
"bsr-border": "boolean" BSR Border configuration for Interface

              }
            ]
          },
          
"rp-static-deny": "string", Configure static RP deny range
          : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
            
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

            
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

            
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
            : {
Clone multicast joinsPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"source": "string", Original source address (S)

                  
"prefix-length": "string", Hash Mask Length for this candidate BSR

                  
"backup": "string", Backup cloned address (S2)

                  
"primary": "string" Primary cloned address (S1)

                }
              ]
            },
            : {
Clone multicast trafficPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"source": "string", Original source address (S)

                  
"prefix-length": "string", Hash Mask Length for this candidate BSR

                  
"backup": "string", Backup cloned address (S2)

                  
"primary": "string" Primary cloned address (S1)

                }
              ]
            },
            
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

          },
          : {
Configure IP Multicast SSMPUTPOSTDELETEGET
            
"range": "string", Access list of groups enabled with SSM

            
"disable": "boolean" TRUE if SSM is disabled on this router

          },
          : {
PIM BSR configurationPUTPOSTDELETEGET
            : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
              
"priority": "string", Priority of the CRP

              
"prefix-length": "string", Hash Mask Length for this candidate BSR

              
"address": "string" Address of Candidate-RP

            },
            : {
PIM RP configurationPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

                  
"priority": "string", Priority of the CRP

                  
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

                  
"mode": "string", SM or Bidir

                  
"address": "string" Address of Candidate-RP

                }
              ]
            }
          },
          
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
          : {
Inheritable defaultsPUTPOSTDELETEGET
            
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

            
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

            
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

            
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

            
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

            
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

            
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

          },
          : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                
"rp-address": "string", RP address of Rendezvous Point

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              }
            ]
          },
          
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
          : {
Configure PIM State LimitsPUTPOSTDELETEGET
            : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
              
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

              
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

            },
            : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
              
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

              
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

            },
            : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
              
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

              
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

            },
            : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
              
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

              
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

            },
            : {
Override default maximum for number of routesPUTPOSTDELETEGET
              
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

              
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

            },
            : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
              
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

              
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

            }
          },
          
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

        },
        : {
IPV6 commandsPUTPOSTDELETEGET
          : {
Configure convergence parametersPUTPOSTDELETEGET
            
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

            
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

          },
          
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
          : {
Configure RPF optionsPUTPOSTDELETEGET
            
"route-policy": "string" Route policy to select RPF topology

          },
          
"multipath": "string", Enable equal-cost multipath routing

          
"register-source": "string", Source address to use for register messages

          
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages

          
"neighbor-filter": "string", Access-list of neighbors to be filtered
          : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                
"rp-address": "string", RP address of Rendezvous Point

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              }
            ]
          },
          
"accept-register": "string", Access-list which specifies unauthorized sources
          : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
            
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          },
          
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
          : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
            
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

            
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

            
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

          },
          : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
            
"rp-list-name": "string", Access-list specifiying applicable RPs

            
"group-list-name": "string" Access-list specifiying applicable groups

          },
          
"embedded-rp-disable": "null", Set Embedded RP processing support

          
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

          
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
          : {
Interface-level ConfigurationPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"neighbor-filter": "string", Access-list of neighbors to be filtered

                
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

                
"interface-name": "string", The name of interface
                : {
Maximum number of PIM routesPUTPOSTDELETEGET
                  
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                  
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

                  
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

                },
                : {
BFD configurationPUTPOSTDELETEGET
                  
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                  
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

                  
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

                },
                
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

                
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

                
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

                
"interface-enable": "boolean", Enable PIM processing on the interface

                
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

                
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

                
"bsr-border": "boolean" BSR Border configuration for Interface

              }
            ]
          },
          : {
Set Embedded RP processing supportPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"rp-address": "string", RP address of Rendezvous Point

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              }
            ]
          },
          : {
PIM BSR configurationPUTPOSTDELETEGET
            : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
              
"priority": "string", Priority of the CRP

              
"prefix-length": "string", Hash Mask Length for this candidate BSR

              
"address": "string" Address of Candidate-RP

            },
            : {
PIM RP configurationPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

                  
"priority": "string", Priority of the CRP

                  
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

                  
"mode": "string", SM or Bidir

                  
"address": "string" Address of Candidate-RP

                }
              ]
            }
          },
          : {
Configure IP Multicast SSMPUTPOSTDELETEGET
            
"range": "string", Access list of groups enabled with SSM

            
"disable": "boolean" TRUE if SSM is disabled on this router

          },
          
"rp-static-deny": "string", Configure static RP deny range

          
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
          : {
Inheritable defaultsPUTPOSTDELETEGET
            
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

            
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

            
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

            
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

            
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

            
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

            
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

          },
          : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                
"rp-address": "string", RP address of Rendezvous Point

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              }
            ]
          },
          
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
          : {
Configure PIM State LimitsPUTPOSTDELETEGET
            : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
              
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

              
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

            },
            : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
              
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

              
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

            },
            : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
              
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

              
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

            },
            : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
              
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

              
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

            },
            : {
Override default maximum for number of routesPUTPOSTDELETEGET
              
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

              
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

            },
            : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
              
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

              
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

            }
          },
          
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

        }
      }
    ]
  }
}

VRF - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/

Update operation of resource: vrf

vrf_schema

vrfbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"vrf-name": "string", VRF name
      : {
IPV4 commandsPUTPOSTDELETEGET
        : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"rpf-proxy-address": "string", RPF Proxy Address

              
"prefix-length": "string", Hash Mask Length for this candidate BSR

              
"source-address": "string" Source Address

            }
          ]
        },
        : [
Configure convergence parametersPUTPOSTDELETEGET
          {
            
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

            
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

          }
        ],
        
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
        : {
Configure RPF optionsPUTPOSTDELETEGET
          
"route-policy": "string" Route policy to select RPF topology

        },
        
"multipath": "string", Enable equal-cost multipath routing

        
"register-source": "string", Source address to use for register messages

        
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
        : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"rpf-proxy-address": "string", RPF Proxy Address

              
"prefix-length": "string", Hash Mask Length for this candidate BSR

              
"source-address": "string" Source Address

            }
          ]
        },
        
"neighbor-filter": "string", Access-list of neighbors to be filtered
        : [
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
          {
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                
"rp-address": "string", RP address of Rendezvous Point

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              }
            ]
          }
        ],
        
"accept-register": "string", Access-list which specifies unauthorized sources
        : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
          
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        },
        
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
        : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
          
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

          
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

        },
        : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
          
"rp-list-name": "string", Access-list specifiying applicable RPs

          
"group-list-name": "string" Access-list specifiying applicable groups

        },
        
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol

        
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

        
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
        : {
Interface-level ConfigurationPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"neighbor-filter": "string", Access-list of neighbors to be filtered

              
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

              
"interface-name": "string", The name of interface
              : {
Maximum number of PIM routesPUTPOSTDELETEGET
                
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              },
              : {
BFD configurationPUTPOSTDELETEGET
                
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

                
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

              },
              
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

              
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

              
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

              
"interface-enable": "boolean", Enable PIM processing on the interface

              
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

              
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

              
"bsr-border": "boolean" BSR Border configuration for Interface

            }
          ]
        },
        
"rp-static-deny": "string", Configure static RP deny range
        : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
          
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

          
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
          : {
Clone multicast joinsPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"source": "string", Original source address (S)

                
"prefix-length": "string", Hash Mask Length for this candidate BSR

                
"backup": "string", Backup cloned address (S2)

                
"primary": "string" Primary cloned address (S1)

              }
            ]
          },
          : {
Clone multicast trafficPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"source": "string", Original source address (S)

                
"prefix-length": "string", Hash Mask Length for this candidate BSR

                
"backup": "string", Backup cloned address (S2)

                
"primary": "string" Primary cloned address (S1)

              }
            ]
          },
          
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

        },
        : {
Configure IP Multicast SSMPUTPOSTDELETEGET
          
"range": "string", Access list of groups enabled with SSM

          
"disable": "boolean" TRUE if SSM is disabled on this router

        },
        : {
PIM BSR configurationPUTPOSTDELETEGET
          : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
            
"priority": "string", Priority of the CRP

            
"prefix-length": "string", Hash Mask Length for this candidate BSR

            
"address": "string" Address of Candidate-RP

          },
          : {
PIM RP configurationPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

                
"priority": "string", Priority of the CRP

                
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

                
"mode": "string", SM or Bidir

                
"address": "string" Address of Candidate-RP

              }
            ]
          }
        },
        
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
        : {
Inheritable defaultsPUTPOSTDELETEGET
          
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

          
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

          
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

          
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

          
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

          
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

          
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

        },
        : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        },
        
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
        : {
Configure PIM State LimitsPUTPOSTDELETEGET
          : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
            
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

            
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

          },
          : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

          },
          : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
            
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
            
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum for number of routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

          },
          : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
            
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          }
        },
        
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

      },
      : {
IPV6 commandsPUTPOSTDELETEGET
        : {
Configure convergence parametersPUTPOSTDELETEGET
          
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

          
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

        },
        
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
        : {
Configure RPF optionsPUTPOSTDELETEGET
          
"route-policy": "string" Route policy to select RPF topology

        },
        
"multipath": "string", Enable equal-cost multipath routing

        
"register-source": "string", Source address to use for register messages

        
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages

        
"neighbor-filter": "string", Access-list of neighbors to be filtered
        : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        },
        
"accept-register": "string", Access-list which specifies unauthorized sources
        : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
          
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        },
        
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
        : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
          
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

          
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

        },
        : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
          
"rp-list-name": "string", Access-list specifiying applicable RPs

          
"group-list-name": "string" Access-list specifiying applicable groups

        },
        
"embedded-rp-disable": "null", Set Embedded RP processing support

        
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

        
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
        : {
Interface-level ConfigurationPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"neighbor-filter": "string", Access-list of neighbors to be filtered

              
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

              
"interface-name": "string", The name of interface
              : {
Maximum number of PIM routesPUTPOSTDELETEGET
                
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              },
              : {
BFD configurationPUTPOSTDELETEGET
                
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

                
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

              },
              
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

              
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

              
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

              
"interface-enable": "boolean", Enable PIM processing on the interface

              
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

              
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

              
"bsr-border": "boolean" BSR Border configuration for Interface

            }
          ]
        },
        : {
Set Embedded RP processing supportPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        },
        : {
PIM BSR configurationPUTPOSTDELETEGET
          : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
            
"priority": "string", Priority of the CRP

            
"prefix-length": "string", Hash Mask Length for this candidate BSR

            
"address": "string" Address of Candidate-RP

          },
          : {
PIM RP configurationPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

                
"priority": "string", Priority of the CRP

                
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

                
"mode": "string", SM or Bidir

                
"address": "string" Address of Candidate-RP

              }
            ]
          }
        },
        : {
Configure IP Multicast SSMPUTPOSTDELETEGET
          
"range": "string", Access list of groups enabled with SSM

          
"disable": "boolean" TRUE if SSM is disabled on this router

        },
        
"rp-static-deny": "string", Configure static RP deny range

        
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
        : {
Inheritable defaultsPUTPOSTDELETEGET
          
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

          
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

          
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

          
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

          
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

          
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

          
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

        },
        : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        },
        
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
        : {
Configure PIM State LimitsPUTPOSTDELETEGET
          : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
            
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

            
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

          },
          : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

          },
          : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
            
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
            
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum for number of routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

          },
          : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
            
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          }
        },
        
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/

Create operation of resource: vrf

vrf_schema

vrfbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"vrf-name": "string", VRF name
      : {
IPV4 commandsPUTPOSTDELETEGET
        : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"rpf-proxy-address": "string", RPF Proxy Address

              
"prefix-length": "string", Hash Mask Length for this candidate BSR

              
"source-address": "string" Source Address

            }
          ]
        },
        : [
Configure convergence parametersPUTPOSTDELETEGET
          {
            
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

            
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

          }
        ],
        
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
        : {
Configure RPF optionsPUTPOSTDELETEGET
          
"route-policy": "string" Route policy to select RPF topology

        },
        
"multipath": "string", Enable equal-cost multipath routing

        
"register-source": "string", Source address to use for register messages

        
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
        : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"rpf-proxy-address": "string", RPF Proxy Address

              
"prefix-length": "string", Hash Mask Length for this candidate BSR

              
"source-address": "string" Source Address

            }
          ]
        },
        
"neighbor-filter": "string", Access-list of neighbors to be filtered
        : [
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
          {
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                
"rp-address": "string", RP address of Rendezvous Point

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              }
            ]
          }
        ],
        
"accept-register": "string", Access-list which specifies unauthorized sources
        : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
          
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        },
        
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
        : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
          
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

          
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

        },
        : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
          
"rp-list-name": "string", Access-list specifiying applicable RPs

          
"group-list-name": "string" Access-list specifiying applicable groups

        },
        
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol

        
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

        
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
        : {
Interface-level ConfigurationPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"neighbor-filter": "string", Access-list of neighbors to be filtered

              
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

              
"interface-name": "string", The name of interface
              : {
Maximum number of PIM routesPUTPOSTDELETEGET
                
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              },
              : {
BFD configurationPUTPOSTDELETEGET
                
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

                
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

              },
              
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

              
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

              
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

              
"interface-enable": "boolean", Enable PIM processing on the interface

              
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

              
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

              
"bsr-border": "boolean" BSR Border configuration for Interface

            }
          ]
        },
        
"rp-static-deny": "string", Configure static RP deny range
        : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
          
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

          
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
          : {
Clone multicast joinsPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"source": "string", Original source address (S)

                
"prefix-length": "string", Hash Mask Length for this candidate BSR

                
"backup": "string", Backup cloned address (S2)

                
"primary": "string" Primary cloned address (S1)

              }
            ]
          },
          : {
Clone multicast trafficPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"source": "string", Original source address (S)

                
"prefix-length": "string", Hash Mask Length for this candidate BSR

                
"backup": "string", Backup cloned address (S2)

                
"primary": "string" Primary cloned address (S1)

              }
            ]
          },
          
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

        },
        : {
Configure IP Multicast SSMPUTPOSTDELETEGET
          
"range": "string", Access list of groups enabled with SSM

          
"disable": "boolean" TRUE if SSM is disabled on this router

        },
        : {
PIM BSR configurationPUTPOSTDELETEGET
          : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
            
"priority": "string", Priority of the CRP

            
"prefix-length": "string", Hash Mask Length for this candidate BSR

            
"address": "string" Address of Candidate-RP

          },
          : {
PIM RP configurationPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

                
"priority": "string", Priority of the CRP

                
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

                
"mode": "string", SM or Bidir

                
"address": "string" Address of Candidate-RP

              }
            ]
          }
        },
        
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
        : {
Inheritable defaultsPUTPOSTDELETEGET
          
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

          
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

          
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

          
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

          
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

          
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

          
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

        },
        : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        },
        
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
        : {
Configure PIM State LimitsPUTPOSTDELETEGET
          : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
            
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

            
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

          },
          : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

          },
          : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
            
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
            
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum for number of routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

          },
          : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
            
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          }
        },
        
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

      },
      : {
IPV6 commandsPUTPOSTDELETEGET
        : {
Configure convergence parametersPUTPOSTDELETEGET
          
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

          
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

        },
        
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
        : {
Configure RPF optionsPUTPOSTDELETEGET
          
"route-policy": "string" Route policy to select RPF topology

        },
        
"multipath": "string", Enable equal-cost multipath routing

        
"register-source": "string", Source address to use for register messages

        
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages

        
"neighbor-filter": "string", Access-list of neighbors to be filtered
        : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        },
        
"accept-register": "string", Access-list which specifies unauthorized sources
        : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
          
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        },
        
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
        : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
          
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

          
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

        },
        : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
          
"rp-list-name": "string", Access-list specifiying applicable RPs

          
"group-list-name": "string" Access-list specifiying applicable groups

        },
        
"embedded-rp-disable": "null", Set Embedded RP processing support

        
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

        
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
        : {
Interface-level ConfigurationPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"neighbor-filter": "string", Access-list of neighbors to be filtered

              
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

              
"interface-name": "string", The name of interface
              : {
Maximum number of PIM routesPUTPOSTDELETEGET
                
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              },
              : {
BFD configurationPUTPOSTDELETEGET
                
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

                
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

              },
              
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

              
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

              
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

              
"interface-enable": "boolean", Enable PIM processing on the interface

              
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

              
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

              
"bsr-border": "boolean" BSR Border configuration for Interface

            }
          ]
        },
        : {
Set Embedded RP processing supportPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        },
        : {
PIM BSR configurationPUTPOSTDELETEGET
          : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
            
"priority": "string", Priority of the CRP

            
"prefix-length": "string", Hash Mask Length for this candidate BSR

            
"address": "string" Address of Candidate-RP

          },
          : {
PIM RP configurationPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

                
"priority": "string", Priority of the CRP

                
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

                
"mode": "string", SM or Bidir

                
"address": "string" Address of Candidate-RP

              }
            ]
          }
        },
        : {
Configure IP Multicast SSMPUTPOSTDELETEGET
          
"range": "string", Access list of groups enabled with SSM

          
"disable": "boolean" TRUE if SSM is disabled on this router

        },
        
"rp-static-deny": "string", Configure static RP deny range

        
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
        : {
Inheritable defaultsPUTPOSTDELETEGET
          
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

          
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

          
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

          
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

          
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

          
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

          
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

        },
        : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        },
        
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
        : {
Configure PIM State LimitsPUTPOSTDELETEGET
          : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
            
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

            
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

          },
          : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

          },
          : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
            
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
            
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum for number of routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

          },
          : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
            
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          }
        },
        
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/

Delete operation of resource: vrf

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/

Retrieve operation of resource: vrf

vrf-name: string
in path

ID of vrf-name

200 OK
vrf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"vrf-name": "string", VRF name
      : {
IPV4 commandsPUTPOSTDELETEGET
        : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"rpf-proxy-address": "string", RPF Proxy Address

              
"prefix-length": "string", Hash Mask Length for this candidate BSR

              
"source-address": "string" Source Address

            }
          ]
        },
        : [
Configure convergence parametersPUTPOSTDELETEGET
          {
            
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

            
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

          }
        ],
        
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
        : {
Configure RPF optionsPUTPOSTDELETEGET
          
"route-policy": "string" Route policy to select RPF topology

        },
        
"multipath": "string", Enable equal-cost multipath routing

        
"register-source": "string", Source address to use for register messages

        
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
        : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"rpf-proxy-address": "string", RPF Proxy Address

              
"prefix-length": "string", Hash Mask Length for this candidate BSR

              
"source-address": "string" Source Address

            }
          ]
        },
        
"neighbor-filter": "string", Access-list of neighbors to be filtered
        : [
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
          {
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

                
"rp-address": "string", RP address of Rendezvous Point

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              }
            ]
          }
        ],
        
"accept-register": "string", Access-list which specifies unauthorized sources
        : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
          
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        },
        
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
        : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
          
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

          
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

        },
        : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
          
"rp-list-name": "string", Access-list specifiying applicable RPs

          
"group-list-name": "string" Access-list specifiying applicable groups

        },
        
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol

        
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

        
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
        : {
Interface-level ConfigurationPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"neighbor-filter": "string", Access-list of neighbors to be filtered

              
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

              
"interface-name": "string", The name of interface
              : {
Maximum number of PIM routesPUTPOSTDELETEGET
                
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              },
              : {
BFD configurationPUTPOSTDELETEGET
                
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

                
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

              },
              
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

              
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

              
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

              
"interface-enable": "boolean", Enable PIM processing on the interface

              
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

              
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

              
"bsr-border": "boolean" BSR Border configuration for Interface

            }
          ]
        },
        
"rp-static-deny": "string", Configure static RP deny range
        : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
          
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

          
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
          : {
Clone multicast joinsPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"source": "string", Original source address (S)

                
"prefix-length": "string", Hash Mask Length for this candidate BSR

                
"backup": "string", Backup cloned address (S2)

                
"primary": "string" Primary cloned address (S1)

              }
            ]
          },
          : {
Clone multicast trafficPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"source": "string", Original source address (S)

                
"prefix-length": "string", Hash Mask Length for this candidate BSR

                
"backup": "string", Backup cloned address (S2)

                
"primary": "string" Primary cloned address (S1)

              }
            ]
          },
          
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

        },
        : {
Configure IP Multicast SSMPUTPOSTDELETEGET
          
"range": "string", Access list of groups enabled with SSM

          
"disable": "boolean" TRUE if SSM is disabled on this router

        },
        : {
PIM BSR configurationPUTPOSTDELETEGET
          : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
            
"priority": "string", Priority of the CRP

            
"prefix-length": "string", Hash Mask Length for this candidate BSR

            
"address": "string" Address of Candidate-RP

          },
          : {
PIM RP configurationPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

                
"priority": "string", Priority of the CRP

                
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

                
"mode": "string", SM or Bidir

                
"address": "string" Address of Candidate-RP

              }
            ]
          }
        },
        
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
        : {
Inheritable defaultsPUTPOSTDELETEGET
          
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

          
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

          
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

          
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

          
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

          
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

          
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

        },
        : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        },
        
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
        : {
Configure PIM State LimitsPUTPOSTDELETEGET
          : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
            
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

            
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

          },
          : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

          },
          : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
            
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
            
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum for number of routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

          },
          : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
            
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          }
        },
        
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

      },
      : {
IPV6 commandsPUTPOSTDELETEGET
        : {
Configure convergence parametersPUTPOSTDELETEGET
          
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

          
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

        },
        
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
        : {
Configure RPF optionsPUTPOSTDELETEGET
          
"route-policy": "string" Route policy to select RPF topology

        },
        
"multipath": "string", Enable equal-cost multipath routing

        
"register-source": "string", Source address to use for register messages

        
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages

        
"neighbor-filter": "string", Access-list of neighbors to be filtered
        : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        },
        
"accept-register": "string", Access-list which specifies unauthorized sources
        : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
          
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        },
        
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
        : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
          
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

          
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

        },
        : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
          
"rp-list-name": "string", Access-list specifiying applicable RPs

          
"group-list-name": "string" Access-list specifiying applicable groups

        },
        
"embedded-rp-disable": "null", Set Embedded RP processing support

        
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

        
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
        : {
Interface-level ConfigurationPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"neighbor-filter": "string", Access-list of neighbors to be filtered

              
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

              
"interface-name": "string", The name of interface
              : {
Maximum number of PIM routesPUTPOSTDELETEGET
                
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

                
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

                
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

              },
              : {
BFD configurationPUTPOSTDELETEGET
                
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

                
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

                
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

              },
              
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

              
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

              
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

              
"interface-enable": "boolean", Enable PIM processing on the interface

              
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

              
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

              
"bsr-border": "boolean" BSR Border configuration for Interface

            }
          ]
        },
        : {
Set Embedded RP processing supportPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        },
        : {
PIM BSR configurationPUTPOSTDELETEGET
          : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
            
"priority": "string", Priority of the CRP

            
"prefix-length": "string", Hash Mask Length for this candidate BSR

            
"address": "string" Address of Candidate-RP

          },
          : {
PIM RP configurationPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

                
"priority": "string", Priority of the CRP

                
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

                
"mode": "string", SM or Bidir

                
"address": "string" Address of Candidate-RP

              }
            ]
          }
        },
        : {
Configure IP Multicast SSMPUTPOSTDELETEGET
          
"range": "string", Access list of groups enabled with SSM

          
"disable": "boolean" TRUE if SSM is disabled on this router

        },
        
"rp-static-deny": "string", Configure static RP deny range

        
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
        : {
Inheritable defaultsPUTPOSTDELETEGET
          
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

          
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

          
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

          
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

          
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

          
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

          
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

        },
        : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        },
        
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
        : {
Configure PIM State LimitsPUTPOSTDELETEGET
          : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
            
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

            
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

          },
          : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

          },
          : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
            
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
            
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          },
          : {
Override default maximum for number of routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

          },
          : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
            
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

            
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

          }
        },
        
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

      }
    }
  ]
}

IPV4 - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/

Update operation of resource: ipv4

ipv4_schema

ipv4body object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
IPV4 commandsPUTPOSTDELETEGET
    : {
Configure Candidate-RPs
      : [
No description
        {
          
"protocol-mode": "string", Protocol Mode

          
"ttl": "string", TTL in Hops

          
"access-list-name": "string", Access list of groups that should map to a\ngiven RP

          
"announce-period": "string", Time between discovery messages 

          
"interface-name": "string" The name of interface

        }
      ]
    },
    : {
Configure Non-stop forwarding (NSF) options
      
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

    },
    : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"rpf-proxy-address": "string", RPF Proxy Address

          
"prefix-length": "string", Mask length

          
"source-address": "string" Source Address

        }
      ]
    },
    : [
Configure convergence parametersPUTPOSTDELETEGET
      {
        
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

        
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

      }
    ],
    
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
    : {
Configure RPF optionsPUTPOSTDELETEGET
      
"route-policy": "string" Route policy to select RPF topology

    },
    
"multipath": "string", Enable equal-cost multipath routing

    
"register-source": "string", Source address to use for register messages

    
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
    : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"rpf-proxy-address": "string", RPF Proxy Address

          
"prefix-length": "string", Mask length

          
"source-address": "string" Source Address

        }
      ]
    },
    
"neighbor-filter": "string", Access-list of neighbors to be filtered
    : [
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
      {
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

            
"rp-address": "string", RP address of Rendezvous Point

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          }
        ]
      }
    ],
    : {
Configure AutoRP Mapping Agent
      : {
Specifications for Mapping Agent configured\non this box
        
"interface-name": "string", The name of interface

        
"announce-period": "string", Time between discovery messages 

        
"ttl": "string" TTL in Hops

      },
      : {
Mapping Agent cache size limit
        
"maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"

        
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"

      }
    },
    : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
      
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    },
    
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
    : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
      
"enable": "null", Enable Multicast Only FRR

      
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

      
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

    },
    : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
      
"rp-list-name": "string", Access-list specifiying applicable RPs

      
"group-list-name": "string" Access-list specifiying applicable groups

    },
    
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol

    
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
    : {
Configure RPF-redirect feature
      
"route-policy": "string" Route policy to select RPF topology

    },
    
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
    : {
Interface-level ConfigurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only
            
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

            
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

            
"bundle-name": "string" Bundle name

          },
          
"enable": "null", Enable Multicast Only FRR

          
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

          
"interface-name": "string", The name of interface
          : {
Maximum number of PIM routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          },
          : {
BFD configurationPUTPOSTDELETEGET
            
"enable": "boolean", Enable Multicast Only FRR

            
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

            
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

          },
          
"neighbor-filter": "string", Access-list of neighbors to be filtered

          
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

          
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

          
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

          
"interface-enable": "boolean", Enable PIM processing on the interface

          
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

          
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

          
"bsr-border": "boolean" BSR Border configuration for Interface

        }
      ]
    },
    : {
PIM BSR configurationPUTPOSTDELETEGET
      : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
        
"priority": "string", Priority of the CRP

        
"prefix-length": "string", Mask length

        
"address": "string" Address of Candidate-RP

      },
      : {
PIM RP configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

            
"priority": "string", Priority of the CRP

            
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

            
"mode": "string", SM or Bidir

            
"address": "string" Address of Candidate-RP

          }
        ]
      }
    },
    : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
      
"enable": "null", Enable Multicast Only FRR

      
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

      
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
      : {
Clone multicast joinsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"source": "string", Original source address (S)

            
"prefix-length": "string", Mask length

            
"backup": "string", Backup cloned address (S2)

            
"primary": "string" Primary cloned address (S1)

          }
        ]
      },
      : {
Clone multicast trafficPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"source": "string", Original source address (S)

            
"prefix-length": "string", Mask length

            
"backup": "string", Backup cloned address (S2)

            
"primary": "string" Primary cloned address (S1)

          }
        ]
      },
      
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

    },
    : {
Configure IP Multicast SSMPUTPOSTDELETEGET
      
"range": "string", Access list of groups enabled with SSM

      
"disable": "boolean" TRUE if SSM is disabled on this router

    },
    
"rp-static-deny": "string", Configure static RP deny range

    
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
    : {
Inheritable defaultsPUTPOSTDELETEGET
      
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

      
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

      
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

      
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

      
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

      
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

      
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

    },
    : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

          
"rp-address": "string", RP address of Rendezvous Point

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        }
      ]
    },
    
"accept-register": "string", Access-list which specifies unauthorized sources

    
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
    : {
Configure PIM State LimitsPUTPOSTDELETEGET
      
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
      : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
        
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

        
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

      },
      : {
Maximum for number of group mappings from\nautorp mapping agent
        
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

        
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

      },
      : {
Override default maximum for number of\nsparse-mode source registers
        
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

      },
      : {
Override default maximum for number of routes
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

      },
      : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
        
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum for number of\nroute-interfaces
        
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSR
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

      },
      
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
      : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
        
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum for number of routesPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

      },
      : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
        
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default global maximum and threshold\nfor C-RP set in BSR
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

      }
    },
    
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/

Create operation of resource: ipv4

ipv4_schema

ipv4body object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
IPV4 commandsPUTPOSTDELETEGET
    : {
Configure Candidate-RPs
      : [
No description
        {
          
"protocol-mode": "string", Protocol Mode

          
"ttl": "string", TTL in Hops

          
"access-list-name": "string", Access list of groups that should map to a\ngiven RP

          
"announce-period": "string", Time between discovery messages 

          
"interface-name": "string" The name of interface

        }
      ]
    },
    : {
Configure Non-stop forwarding (NSF) options
      
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

    },
    : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"rpf-proxy-address": "string", RPF Proxy Address

          
"prefix-length": "string", Mask length

          
"source-address": "string" Source Address

        }
      ]
    },
    : [
Configure convergence parametersPUTPOSTDELETEGET
      {
        
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

        
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

      }
    ],
    
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
    : {
Configure RPF optionsPUTPOSTDELETEGET
      
"route-policy": "string" Route policy to select RPF topology

    },
    
"multipath": "string", Enable equal-cost multipath routing

    
"register-source": "string", Source address to use for register messages

    
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
    : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"rpf-proxy-address": "string", RPF Proxy Address

          
"prefix-length": "string", Mask length

          
"source-address": "string" Source Address

        }
      ]
    },
    
"neighbor-filter": "string", Access-list of neighbors to be filtered
    : [
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
      {
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

            
"rp-address": "string", RP address of Rendezvous Point

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          }
        ]
      }
    ],
    : {
Configure AutoRP Mapping Agent
      : {
Specifications for Mapping Agent configured\non this box
        
"interface-name": "string", The name of interface

        
"announce-period": "string", Time between discovery messages 

        
"ttl": "string" TTL in Hops

      },
      : {
Mapping Agent cache size limit
        
"maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"

        
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"

      }
    },
    : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
      
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    },
    
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
    : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
      
"enable": "null", Enable Multicast Only FRR

      
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

      
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

    },
    : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
      
"rp-list-name": "string", Access-list specifiying applicable RPs

      
"group-list-name": "string" Access-list specifiying applicable groups

    },
    
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol

    
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
    : {
Configure RPF-redirect feature
      
"route-policy": "string" Route policy to select RPF topology

    },
    
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
    : {
Interface-level ConfigurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only
            
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

            
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

            
"bundle-name": "string" Bundle name

          },
          
"enable": "null", Enable Multicast Only FRR

          
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

          
"interface-name": "string", The name of interface
          : {
Maximum number of PIM routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          },
          : {
BFD configurationPUTPOSTDELETEGET
            
"enable": "boolean", Enable Multicast Only FRR

            
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

            
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

          },
          
"neighbor-filter": "string", Access-list of neighbors to be filtered

          
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

          
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

          
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

          
"interface-enable": "boolean", Enable PIM processing on the interface

          
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

          
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

          
"bsr-border": "boolean" BSR Border configuration for Interface

        }
      ]
    },
    : {
PIM BSR configurationPUTPOSTDELETEGET
      : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
        
"priority": "string", Priority of the CRP

        
"prefix-length": "string", Mask length

        
"address": "string" Address of Candidate-RP

      },
      : {
PIM RP configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

            
"priority": "string", Priority of the CRP

            
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

            
"mode": "string", SM or Bidir

            
"address": "string" Address of Candidate-RP

          }
        ]
      }
    },
    : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
      
"enable": "null", Enable Multicast Only FRR

      
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

      
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
      : {
Clone multicast joinsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"source": "string", Original source address (S)

            
"prefix-length": "string", Mask length

            
"backup": "string", Backup cloned address (S2)

            
"primary": "string" Primary cloned address (S1)

          }
        ]
      },
      : {
Clone multicast trafficPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"source": "string", Original source address (S)

            
"prefix-length": "string", Mask length

            
"backup": "string", Backup cloned address (S2)

            
"primary": "string" Primary cloned address (S1)

          }
        ]
      },
      
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

    },
    : {
Configure IP Multicast SSMPUTPOSTDELETEGET
      
"range": "string", Access list of groups enabled with SSM

      
"disable": "boolean" TRUE if SSM is disabled on this router

    },
    
"rp-static-deny": "string", Configure static RP deny range

    
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
    : {
Inheritable defaultsPUTPOSTDELETEGET
      
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

      
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

      
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

      
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

      
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

      
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

      
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

    },
    : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

          
"rp-address": "string", RP address of Rendezvous Point

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        }
      ]
    },
    
"accept-register": "string", Access-list which specifies unauthorized sources

    
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
    : {
Configure PIM State LimitsPUTPOSTDELETEGET
      
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
      : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
        
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

        
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

      },
      : {
Maximum for number of group mappings from\nautorp mapping agent
        
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

        
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

      },
      : {
Override default maximum for number of\nsparse-mode source registers
        
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

      },
      : {
Override default maximum for number of routes
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

      },
      : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
        
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum for number of\nroute-interfaces
        
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSR
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

      },
      
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
      : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
        
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum for number of routesPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

      },
      : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
        
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default global maximum and threshold\nfor C-RP set in BSR
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

      }
    },
    
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/

Delete operation of resource: ipv4

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/

Retrieve operation of resource: ipv4

vrf-name: string
in path

ID of vrf-name

200 OK
ipv4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IPV4 commandsPUTPOSTDELETEGET
    : {
Configure Candidate-RPs
      : [
No description
        {
          
"protocol-mode": "string", Protocol Mode

          
"ttl": "string", TTL in Hops

          
"access-list-name": "string", Access list of groups that should map to a\ngiven RP

          
"announce-period": "string", Time between discovery messages 

          
"interface-name": "string" The name of interface

        }
      ]
    },
    : {
Configure Non-stop forwarding (NSF) options
      
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

    },
    : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"rpf-proxy-address": "string", RPF Proxy Address

          
"prefix-length": "string", Mask length

          
"source-address": "string" Source Address

        }
      ]
    },
    : [
Configure convergence parametersPUTPOSTDELETEGET
      {
        
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

        
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

      }
    ],
    
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
    : {
Configure RPF optionsPUTPOSTDELETEGET
      
"route-policy": "string" Route policy to select RPF topology

    },
    
"multipath": "string", Enable equal-cost multipath routing

    
"register-source": "string", Source address to use for register messages

    
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
    : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"rpf-proxy-address": "string", RPF Proxy Address

          
"prefix-length": "string", Mask length

          
"source-address": "string" Source Address

        }
      ]
    },
    
"neighbor-filter": "string", Access-list of neighbors to be filtered
    : [
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
      {
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

            
"rp-address": "string", RP address of Rendezvous Point

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          }
        ]
      }
    ],
    : {
Configure AutoRP Mapping Agent
      : {
Specifications for Mapping Agent configured\non this box
        
"interface-name": "string", The name of interface

        
"announce-period": "string", Time between discovery messages 

        
"ttl": "string" TTL in Hops

      },
      : {
Mapping Agent cache size limit
        
"maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"

        
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"

      }
    },
    : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
      
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    },
    
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
    : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
      
"enable": "null", Enable Multicast Only FRR

      
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

      
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

    },
    : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
      
"rp-list-name": "string", Access-list specifiying applicable RPs

      
"group-list-name": "string" Access-list specifiying applicable groups

    },
    
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol

    
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
    : {
Configure RPF-redirect feature
      
"route-policy": "string" Route policy to select RPF topology

    },
    
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
    : {
Interface-level ConfigurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only
            
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

            
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

            
"bundle-name": "string" Bundle name

          },
          
"enable": "null", Enable Multicast Only FRR

          
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

          
"interface-name": "string", The name of interface
          : {
Maximum number of PIM routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          },
          : {
BFD configurationPUTPOSTDELETEGET
            
"enable": "boolean", Enable Multicast Only FRR

            
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

            
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

          },
          
"neighbor-filter": "string", Access-list of neighbors to be filtered

          
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

          
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

          
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

          
"interface-enable": "boolean", Enable PIM processing on the interface

          
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

          
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

          
"bsr-border": "boolean" BSR Border configuration for Interface

        }
      ]
    },
    : {
PIM BSR configurationPUTPOSTDELETEGET
      : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
        
"priority": "string", Priority of the CRP

        
"prefix-length": "string", Mask length

        
"address": "string" Address of Candidate-RP

      },
      : {
PIM RP configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

            
"priority": "string", Priority of the CRP

            
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

            
"mode": "string", SM or Bidir

            
"address": "string" Address of Candidate-RP

          }
        ]
      }
    },
    : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
      
"enable": "null", Enable Multicast Only FRR

      
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

      
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
      : {
Clone multicast joinsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"source": "string", Original source address (S)

            
"prefix-length": "string", Mask length

            
"backup": "string", Backup cloned address (S2)

            
"primary": "string" Primary cloned address (S1)

          }
        ]
      },
      : {
Clone multicast trafficPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"source": "string", Original source address (S)

            
"prefix-length": "string", Mask length

            
"backup": "string", Backup cloned address (S2)

            
"primary": "string" Primary cloned address (S1)

          }
        ]
      },
      
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

    },
    : {
Configure IP Multicast SSMPUTPOSTDELETEGET
      
"range": "string", Access list of groups enabled with SSM

      
"disable": "boolean" TRUE if SSM is disabled on this router

    },
    
"rp-static-deny": "string", Configure static RP deny range

    
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
    : {
Inheritable defaultsPUTPOSTDELETEGET
      
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

      
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

      
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

      
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

      
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

      
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

      
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

    },
    : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

          
"rp-address": "string", RP address of Rendezvous Point

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        }
      ]
    },
    
"accept-register": "string", Access-list which specifies unauthorized sources

    
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
    : {
Configure PIM State LimitsPUTPOSTDELETEGET
      
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
      : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
        
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

        
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

      },
      : {
Maximum for number of group mappings from\nautorp mapping agent
        
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

        
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

      },
      : {
Override default maximum for number of\nsparse-mode source registers
        
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

      },
      : {
Override default maximum for number of routes
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

      },
      : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
        
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum for number of\nroute-interfaces
        
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSR
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

      },
      
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
      : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
        
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum for number of routesPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

      },
      : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
        
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default global maximum and threshold\nfor C-RP set in BSR
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

      }
    },
    
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

  }
}

SPARSE-MODE-RP-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/sparse-mode-rp-addresses/

Update operation of resource: sparse-mode-rp-addresses

sparse-mode-rp-addresses_schema

sparse-mode-rp-addressesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

        
"rp-address": "string", RP address of Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SPARSE-MODE-RP-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/sparse-mode-rp-addresses/

Create operation of resource: sparse-mode-rp-addresses

sparse-mode-rp-addresses_schema

sparse-mode-rp-addressesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

        
"rp-address": "string", RP address of Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SPARSE-MODE-RP-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/sparse-mode-rp-addresses/

Delete operation of resource: sparse-mode-rp-addresses

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SPARSE-MODE-RP-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/sparse-mode-rp-addresses/

Retrieve operation of resource: sparse-mode-rp-addresses

vrf-name: string
in path

ID of vrf-name

200 OK
sparse-mode-rp-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

        
"rp-address": "string", RP address of Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}

SPARSE-MODE-RP-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/sparse-mode-rp-addresses/sparse-mode-rp-address/{rp-address}/

Update operation of resource: sparse-mode-rp-address

sparse-mode-rp-address_schema

sparse-mode-rp-addressbody object

vrf-name: string
in path

ID of vrf-name

rp-address: string
in path

ID of rp-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

      
"rp-address": "string", RP address of Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SPARSE-MODE-RP-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/sparse-mode-rp-addresses/sparse-mode-rp-address/{rp-address}/

Create operation of resource: sparse-mode-rp-address

sparse-mode-rp-address_schema

sparse-mode-rp-addressbody object

vrf-name: string
in path

ID of vrf-name

rp-address: string
in path

ID of rp-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

      
"rp-address": "string", RP address of Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SPARSE-MODE-RP-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/sparse-mode-rp-addresses/sparse-mode-rp-address/{rp-address}/

Delete operation of resource: sparse-mode-rp-address

vrf-name: string
in path

ID of vrf-name

rp-address: string
in path

ID of rp-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SPARSE-MODE-RP-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/sparse-mode-rp-addresses/sparse-mode-rp-address/{rp-address}/

Retrieve operation of resource: sparse-mode-rp-address

vrf-name: string
in path

ID of vrf-name

rp-address: string
in path

ID of rp-address

200 OK
sparse-mode-rp-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

      
"rp-address": "string", RP address of Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}

INHERITABLE-DEFAULTS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/inheritable-defaults/

Update operation of resource: inheritable-defaults

inheritable-defaults_schema

inheritable-defaultsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Inheritable defaultsPUTPOSTDELETEGET
    
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

    
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

    
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

    
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

    
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

    
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

    
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERITABLE-DEFAULTS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/inheritable-defaults/

Create operation of resource: inheritable-defaults

inheritable-defaults_schema

inheritable-defaultsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Inheritable defaultsPUTPOSTDELETEGET
    
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

    
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

    
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

    
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

    
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

    
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

    
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERITABLE-DEFAULTS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/inheritable-defaults/

Delete operation of resource: inheritable-defaults

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERITABLE-DEFAULTS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/inheritable-defaults/

Retrieve operation of resource: inheritable-defaults

vrf-name: string
in path

ID of vrf-name

200 OK
inheritable-defaults_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Inheritable defaultsPUTPOSTDELETEGET
    
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

    
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

    
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

    
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

    
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

    
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

    
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

  }
}

RPF - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/rpf/

Update operation of resource: rpf

rpf_schema

rpfbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure RPF optionsPUTPOSTDELETEGET
    
"route-policy": "string" Route policy to select RPF topology

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/rpf/

Create operation of resource: rpf

rpf_schema

rpfbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure RPF optionsPUTPOSTDELETEGET
    
"route-policy": "string" Route policy to select RPF topology

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/rpf/

Delete operation of resource: rpf

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/rpf/

Retrieve operation of resource: rpf

vrf-name: string
in path

ID of vrf-name

200 OK
rpf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure RPF optionsPUTPOSTDELETEGET
    
"route-policy": "string" Route policy to select RPF topology

  }
}

MAXIMUM - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/

Update operation of resource: maximum

maximum_schema

maximumbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure PIM State LimitsPUTPOSTDELETEGET
    
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
    : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
      
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

      
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

    },
    : {
Maximum for number of group mappings from\nautorp mapping agent
      
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

      
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

    },
    : {
Override default maximum for number of\nsparse-mode source registers
      
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

    },
    : {
Override default maximum for number of routes
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

    },
    : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
      
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum for number of\nroute-interfaces
      
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSR
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

    },
    
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
    : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
      
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum for number of routesPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

    },
    : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
      
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default global maximum and threshold\nfor C-RP set in BSR
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/

Create operation of resource: maximum

maximum_schema

maximumbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure PIM State LimitsPUTPOSTDELETEGET
    
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
    : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
      
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

      
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

    },
    : {
Maximum for number of group mappings from\nautorp mapping agent
      
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

      
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

    },
    : {
Override default maximum for number of\nsparse-mode source registers
      
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

    },
    : {
Override default maximum for number of routes
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

    },
    : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
      
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum for number of\nroute-interfaces
      
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSR
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

    },
    
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
    : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
      
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum for number of routesPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

    },
    : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
      
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default global maximum and threshold\nfor C-RP set in BSR
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/

Delete operation of resource: maximum

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/

Retrieve operation of resource: maximum

vrf-name: string
in path

ID of vrf-name

200 OK
maximum_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure PIM State LimitsPUTPOSTDELETEGET
    
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
    : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
      
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

      
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

    },
    : {
Maximum for number of group mappings from\nautorp mapping agent
      
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

      
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

    },
    : {
Override default maximum for number of\nsparse-mode source registers
      
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

    },
    : {
Override default maximum for number of routes
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

    },
    : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
      
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum for number of\nroute-interfaces
      
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSR
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

    },
    
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
    : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
      
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum for number of routesPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

    },
    : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
      
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default global maximum and threshold\nfor C-RP set in BSR
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

    }
  }
}

GROUP-MAPPINGS-AUTO-RP - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/group-mappings-auto-rp/

Update operation of resource: group-mappings-auto-rp

group-mappings-auto-rp_schema

group-mappings-auto-rpbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
    
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

    
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-MAPPINGS-AUTO-RP - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/group-mappings-auto-rp/

Create operation of resource: group-mappings-auto-rp

group-mappings-auto-rp_schema

group-mappings-auto-rpbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
    
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

    
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-MAPPINGS-AUTO-RP - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/group-mappings-auto-rp/

Delete operation of resource: group-mappings-auto-rp

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-MAPPINGS-AUTO-RP - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/group-mappings-auto-rp/

Retrieve operation of resource: group-mappings-auto-rp

vrf-name: string
in path

ID of vrf-name

200 OK
group-mappings-auto-rp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
    
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

    
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

  }
}

BSR-GROUP-MAPPINGS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/bsr-group-mappings/

Update operation of resource: bsr-group-mappings

bsr-group-mappings_schema

bsr-group-mappingsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-GROUP-MAPPINGS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/bsr-group-mappings/

Create operation of resource: bsr-group-mappings

bsr-group-mappings_schema

bsr-group-mappingsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-GROUP-MAPPINGS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/bsr-group-mappings/

Delete operation of resource: bsr-group-mappings

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-GROUP-MAPPINGS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/bsr-group-mappings/

Retrieve operation of resource: bsr-group-mappings

vrf-name: string
in path

ID of vrf-name

200 OK
bsr-group-mappings_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

  }
}

REGISTER-STATES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/register-states/

Update operation of resource: register-states

register-states_schema

register-statesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
    
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REGISTER-STATES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/register-states/

Create operation of resource: register-states

register-states_schema

register-statesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
    
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REGISTER-STATES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/register-states/

Delete operation of resource: register-states

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REGISTER-STATES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/register-states/

Retrieve operation of resource: register-states

vrf-name: string
in path

ID of vrf-name

200 OK
register-states_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
    
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}

ROUTE-INTERFACES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/route-interfaces/

Update operation of resource: route-interfaces

route-interfaces_schema

route-interfacesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
    
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTE-INTERFACES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/route-interfaces/

Create operation of resource: route-interfaces

route-interfaces_schema

route-interfacesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
    
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTE-INTERFACES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/route-interfaces/

Delete operation of resource: route-interfaces

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTE-INTERFACES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/route-interfaces/

Retrieve operation of resource: route-interfaces

vrf-name: string
in path

ID of vrf-name

200 OK
route-interfaces_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
    
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}

BSR-CANDIDATE-RP-CACHE - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/bsr-candidate-rp-cache/

Update operation of resource: bsr-candidate-rp-cache

bsr-candidate-rp-cache_schema

bsr-candidate-rp-cachebody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
    
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-CANDIDATE-RP-CACHE - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/bsr-candidate-rp-cache/

Create operation of resource: bsr-candidate-rp-cache

bsr-candidate-rp-cache_schema

bsr-candidate-rp-cachebody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
    
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-CANDIDATE-RP-CACHE - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/bsr-candidate-rp-cache/

Delete operation of resource: bsr-candidate-rp-cache

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-CANDIDATE-RP-CACHE - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/bsr-candidate-rp-cache/

Retrieve operation of resource: bsr-candidate-rp-cache

vrf-name: string
in path

ID of vrf-name

200 OK
bsr-candidate-rp-cache_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
    
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}

ROUTES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/routes/

Update operation of resource: routes

routes_schema

routesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of routesPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/routes/

Create operation of resource: routes

routes_schema

routesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of routesPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/routes/

Delete operation of resource: routes

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/maximum/routes/

Retrieve operation of resource: routes

vrf-name: string
in path

ID of vrf-name

200 OK
routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum for number of routesPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

  }
}

SG-EXPIRY-TIMER - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/sg-expiry-timer/

Update operation of resource: sg-expiry-timer

sg-expiry-timer_schema

sg-expiry-timerbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
    
"interval": "integer", (S,G) expiry time in seconds
range: "30..600"
units: "second"
default: "60"

    
"access-list-name": "string" Access-list of applicable S,G routes

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SG-EXPIRY-TIMER - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/sg-expiry-timer/

Create operation of resource: sg-expiry-timer

sg-expiry-timer_schema

sg-expiry-timerbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
    
"interval": "integer", (S,G) expiry time in seconds
range: "30..600"
units: "second"
default: "60"

    
"access-list-name": "string" Access-list of applicable S,G routes

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SG-EXPIRY-TIMER - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/sg-expiry-timer/

Delete operation of resource: sg-expiry-timer

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SG-EXPIRY-TIMER - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/sg-expiry-timer/

Retrieve operation of resource: sg-expiry-timer

vrf-name: string
in path

ID of vrf-name

200 OK
sg-expiry-timer_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
    
"interval": "integer", (S,G) expiry time in seconds
range: "30..600"
units: "second"
default: "60"

    
"access-list-name": "string" Access-list of applicable S,G routes

  }
}

RPF-VECTOR-ENABLE - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/rpf-vector-enable/

Update operation of resource: rpf-vector-enable

rpf-vector-enable_schema

rpf-vector-enablebody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
    
"enable": "null", RPF Vector is turned on if configured

    
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

    
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF-VECTOR-ENABLE - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/rpf-vector-enable/

Create operation of resource: rpf-vector-enable

rpf-vector-enable_schema

rpf-vector-enablebody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
    
"enable": "null", RPF Vector is turned on if configured

    
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

    
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF-VECTOR-ENABLE - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/rpf-vector-enable/

Delete operation of resource: rpf-vector-enable

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF-VECTOR-ENABLE - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/rpf-vector-enable/

Retrieve operation of resource: rpf-vector-enable

vrf-name: string
in path

ID of vrf-name

200 OK
rpf-vector-enable_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
    
"enable": "null", RPF Vector is turned on if configured

    
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

    
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

  }
}

SSM - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/ssm/

Update operation of resource: ssm

ssm_schema

ssmbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure IP Multicast SSMPUTPOSTDELETEGET
    
"range": "string", Access list of groups enabled with SSM

    
"disable": "boolean" TRUE if SSM is disabled on this router

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/ssm/

Create operation of resource: ssm

ssm_schema

ssmbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure IP Multicast SSMPUTPOSTDELETEGET
    
"range": "string", Access list of groups enabled with SSM

    
"disable": "boolean" TRUE if SSM is disabled on this router

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/ssm/

Delete operation of resource: ssm

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/ssm/

Retrieve operation of resource: ssm

vrf-name: string
in path

ID of vrf-name

200 OK
ssm_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure IP Multicast SSMPUTPOSTDELETEGET
    
"range": "string", Access list of groups enabled with SSM

    
"disable": "boolean" TRUE if SSM is disabled on this router

  }
}

INJECTS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/injects/

Update operation of resource: injects

injects_schema

injectsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"rpf-proxy-address": "string", RPF Proxy Address

        
"prefix-length": "string", Masklen

        
"source-address": "string" Source Address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INJECTS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/injects/

Create operation of resource: injects

injects_schema

injectsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"rpf-proxy-address": "string", RPF Proxy Address

        
"prefix-length": "string", Masklen

        
"source-address": "string" Source Address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INJECTS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/injects/

Delete operation of resource: injects

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INJECTS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/injects/

Retrieve operation of resource: injects

vrf-name: string
in path

ID of vrf-name

200 OK
injects_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"rpf-proxy-address": "string", RPF Proxy Address

        
"prefix-length": "string", Masklen

        
"source-address": "string" Source Address

      }
    ]
  }
}

INJECT - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/injects/inject/{source-address prefix-length}/

Update operation of resource: inject

inject_schema

injectbody object

vrf-name: string
in path

ID of vrf-name

source-address prefix-length: string
in path

ID of source-address prefix-length

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"rpf-proxy-address": "string", RPF Proxy Address

      
"prefix-length": "string", Masklen

      
"source-address": "string" Source Address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INJECT - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/injects/inject/{source-address prefix-length}/

Create operation of resource: inject

inject_schema

injectbody object

vrf-name: string
in path

ID of vrf-name

source-address prefix-length: string
in path

ID of source-address prefix-length

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"rpf-proxy-address": "string", RPF Proxy Address

      
"prefix-length": "string", Masklen

      
"source-address": "string" Source Address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INJECT - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/injects/inject/{source-address prefix-length}/

Delete operation of resource: inject

vrf-name: string
in path

ID of vrf-name

source-address prefix-length: string
in path

ID of source-address prefix-length

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INJECT - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/injects/inject/{source-address prefix-length}/

Retrieve operation of resource: inject

vrf-name: string
in path

ID of vrf-name

source-address prefix-length: string
in path

ID of source-address prefix-length

200 OK
inject_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"rpf-proxy-address": "string", RPF Proxy Address

      
"prefix-length": "string", Masklen

      
"source-address": "string" Source Address

    }
  ]
}

BIDIR-RP-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/bidir-rp-addresses/

Update operation of resource: bidir-rp-addresses

bidir-rp-addresses_schema

bidir-rp-addressesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

        
"rp-address": "string", RP address of Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BIDIR-RP-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/bidir-rp-addresses/

Create operation of resource: bidir-rp-addresses

bidir-rp-addresses_schema

bidir-rp-addressesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

        
"rp-address": "string", RP address of Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BIDIR-RP-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/bidir-rp-addresses/

Delete operation of resource: bidir-rp-addresses

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BIDIR-RP-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/bidir-rp-addresses/

Retrieve operation of resource: bidir-rp-addresses

vrf-name: string
in path

ID of vrf-name

200 OK
bidir-rp-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

        
"rp-address": "string", RP address of Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}

BIDIR-RP-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/bidir-rp-addresses/bidir-rp-address/{rp-address}/

Update operation of resource: bidir-rp-address

bidir-rp-address_schema

bidir-rp-addressbody object

vrf-name: string
in path

ID of vrf-name

rp-address: string
in path

ID of rp-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

      
"rp-address": "string", RP address of Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BIDIR-RP-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/bidir-rp-addresses/bidir-rp-address/{rp-address}/

Create operation of resource: bidir-rp-address

bidir-rp-address_schema

bidir-rp-addressbody object

vrf-name: string
in path

ID of vrf-name

rp-address: string
in path

ID of rp-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

      
"rp-address": "string", RP address of Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BIDIR-RP-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/bidir-rp-addresses/bidir-rp-address/{rp-address}/

Delete operation of resource: bidir-rp-address

vrf-name: string
in path

ID of vrf-name

rp-address: string
in path

ID of rp-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BIDIR-RP-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/bidir-rp-addresses/bidir-rp-address/{rp-address}/

Retrieve operation of resource: bidir-rp-address

vrf-name: string
in path

ID of vrf-name

rp-address: string
in path

ID of rp-address

200 OK
bidir-rp-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

      
"rp-address": "string", RP address of Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}

BSR - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/bsr/

Update operation of resource: bsr

bsr_schema

bsrbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
PIM BSR configurationPUTPOSTDELETEGET
    : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
      
"priority": "string", Priority of the CRP

      
"prefix-length": "string", Hash Mask Length for this candidate BSR

      
"address": "string" Address of Candidate-RP

    },
    : {
PIM RP configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

          
"priority": "string", Priority of the CRP

          
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

          
"mode": "string", SM or Bidir

          
"address": "string" Address of Candidate-RP

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/bsr/

Create operation of resource: bsr

bsr_schema

bsrbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
PIM BSR configurationPUTPOSTDELETEGET
    : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
      
"priority": "string", Priority of the CRP

      
"prefix-length": "string", Hash Mask Length for this candidate BSR

      
"address": "string" Address of Candidate-RP

    },
    : {
PIM RP configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

          
"priority": "string", Priority of the CRP

          
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

          
"mode": "string", SM or Bidir

          
"address": "string" Address of Candidate-RP

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/bsr/

Delete operation of resource: bsr

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/bsr/

Retrieve operation of resource: bsr

vrf-name: string
in path

ID of vrf-name

200 OK
bsr_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
PIM BSR configurationPUTPOSTDELETEGET
    : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
      
"priority": "string", Priority of the CRP

      
"prefix-length": "string", Hash Mask Length for this candidate BSR

      
"address": "string" Address of Candidate-RP

    },
    : {
PIM RP configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

          
"priority": "string", Priority of the CRP

          
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

          
"mode": "string", SM or Bidir

          
"address": "string" Address of Candidate-RP

        }
      ]
    }
  }
}

CANDIDATE-BSR - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/bsr/candidate-bsr/

Update operation of resource: candidate-bsr

candidate-bsr_schema

candidate-bsrbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
    
"priority": "string", Priority of the Candidate BSR

    
"prefix-length": "string", Hash Mask Length for this candidate BSR

    
"address": "string" BSR Address configured

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-BSR - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/bsr/candidate-bsr/

Create operation of resource: candidate-bsr

candidate-bsr_schema

candidate-bsrbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
    
"priority": "string", Priority of the Candidate BSR

    
"prefix-length": "string", Hash Mask Length for this candidate BSR

    
"address": "string" BSR Address configured

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-BSR - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/bsr/candidate-bsr/

Delete operation of resource: candidate-bsr

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-BSR - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/bsr/candidate-bsr/

Retrieve operation of resource: candidate-bsr

vrf-name: string
in path

ID of vrf-name

200 OK
candidate-bsr_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
    
"priority": "string", Priority of the Candidate BSR

    
"prefix-length": "string", Hash Mask Length for this candidate BSR

    
"address": "string" BSR Address configured

  }
}

CANDIDATE-RPS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/bsr/candidate-rps/

Update operation of resource: candidate-rps

candidate-rps_schema

candidate-rpsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
PIM RP configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

        
"priority": "string", Priority of the CRP

        
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

        
"mode": "string", SM or Bidir

        
"address": "string" Address of Candidate-RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-RPS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/bsr/candidate-rps/

Create operation of resource: candidate-rps

candidate-rps_schema

candidate-rpsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
PIM RP configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

        
"priority": "string", Priority of the CRP

        
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

        
"mode": "string", SM or Bidir

        
"address": "string" Address of Candidate-RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-RPS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/bsr/candidate-rps/

Delete operation of resource: candidate-rps

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-RPS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/bsr/candidate-rps/

Retrieve operation of resource: candidate-rps

vrf-name: string
in path

ID of vrf-name

200 OK
candidate-rps_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
PIM RP configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

        
"priority": "string", Priority of the CRP

        
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

        
"mode": "string", SM or Bidir

        
"address": "string" Address of Candidate-RP

      }
    ]
  }
}

CANDIDATE-RP - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/bsr/candidate-rps/candidate-rp/{address mode}/

Update operation of resource: candidate-rp

candidate-rp_schema

candidate-rpbody object

vrf-name: string
in path

ID of vrf-name

address mode: string
in path

ID of address mode

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

      
"priority": "string", Priority of the CRP

      
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

      
"mode": "string", SM or Bidir

      
"address": "string" Address of Candidate-RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-RP - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/bsr/candidate-rps/candidate-rp/{address mode}/

Create operation of resource: candidate-rp

candidate-rp_schema

candidate-rpbody object

vrf-name: string
in path

ID of vrf-name

address mode: string
in path

ID of address mode

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

      
"priority": "string", Priority of the CRP

      
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

      
"mode": "string", SM or Bidir

      
"address": "string" Address of Candidate-RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-RP - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/bsr/candidate-rps/candidate-rp/{address mode}/

Delete operation of resource: candidate-rp

vrf-name: string
in path

ID of vrf-name

address mode: string
in path

ID of address mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-RP - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/bsr/candidate-rps/candidate-rp/{address mode}/

Retrieve operation of resource: candidate-rp

vrf-name: string
in path

ID of vrf-name

address mode: string
in path

ID of address mode

200 OK
candidate-rp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

      
"priority": "string", Priority of the CRP

      
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

      
"mode": "string", SM or Bidir

      
"address": "string" Address of Candidate-RP

    }
  ]
}

MOFRR - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/mofrr/

Update operation of resource: mofrr

mofrr_schema

mofrrbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
    
"enable": "null", Enable Multicast Only FRR

    
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

    
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
    : {
Clone multicast joinsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"source": "string", Original source address (S)

          
"prefix-length": "string", Mask length

          
"backup": "string", Backup cloned address (S2)

          
"primary": "string" Primary cloned address (S1)

        }
      ]
    },
    : {
Clone multicast trafficPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"source": "string", Original source address (S)

          
"prefix-length": "string", Mask length

          
"backup": "string", Backup cloned address (S2)

          
"primary": "string" Primary cloned address (S1)

        }
      ]
    },
    
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MOFRR - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/mofrr/

Create operation of resource: mofrr

mofrr_schema

mofrrbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
    
"enable": "null", Enable Multicast Only FRR

    
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

    
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
    : {
Clone multicast joinsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"source": "string", Original source address (S)

          
"prefix-length": "string", Mask length

          
"backup": "string", Backup cloned address (S2)

          
"primary": "string" Primary cloned address (S1)

        }
      ]
    },
    : {
Clone multicast trafficPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"source": "string", Original source address (S)

          
"prefix-length": "string", Mask length

          
"backup": "string", Backup cloned address (S2)

          
"primary": "string" Primary cloned address (S1)

        }
      ]
    },
    
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MOFRR - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/mofrr/

Delete operation of resource: mofrr

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MOFRR - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/mofrr/

Retrieve operation of resource: mofrr

vrf-name: string
in path

ID of vrf-name

200 OK
mofrr_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
    
"enable": "null", Enable Multicast Only FRR

    
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

    
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
    : {
Clone multicast joinsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"source": "string", Original source address (S)

          
"prefix-length": "string", Mask length

          
"backup": "string", Backup cloned address (S2)

          
"primary": "string" Primary cloned address (S1)

        }
      ]
    },
    : {
Clone multicast trafficPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"source": "string", Original source address (S)

          
"prefix-length": "string", Mask length

          
"backup": "string", Backup cloned address (S2)

          
"primary": "string" Primary cloned address (S1)

        }
      ]
    },
    
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

  }
}

CLONE-JOINS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/mofrr/clone-joins/

Update operation of resource: clone-joins

clone-joins_schema

clone-joinsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Clone multicast joinsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"source": "string", Original source address (S)

        
"prefix-length": "string", Mask length

        
"backup": "string", Backup cloned address (S2)

        
"primary": "string" Primary cloned address (S1)

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLONE-JOINS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/mofrr/clone-joins/

Create operation of resource: clone-joins

clone-joins_schema

clone-joinsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Clone multicast joinsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"source": "string", Original source address (S)

        
"prefix-length": "string", Mask length

        
"backup": "string", Backup cloned address (S2)

        
"primary": "string" Primary cloned address (S1)

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLONE-JOINS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/mofrr/clone-joins/

Delete operation of resource: clone-joins

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLONE-JOINS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/mofrr/clone-joins/

Retrieve operation of resource: clone-joins

vrf-name: string
in path

ID of vrf-name

200 OK
clone-joins_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Clone multicast joinsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"source": "string", Original source address (S)

        
"prefix-length": "string", Mask length

        
"backup": "string", Backup cloned address (S2)

        
"primary": "string" Primary cloned address (S1)

      }
    ]
  }
}

CLONE-JOIN - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/mofrr/clone-joins/clone-join/{source primary backup prefix-length}/

Update operation of resource: clone-join

clone-join_schema

clone-joinbody object

vrf-name: string
in path

ID of vrf-name

source primary backup prefix-length: string
in path

ID of source primary backup prefix-length

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"source": "string", Original source address (S)

      
"prefix-length": "string", Mask length

      
"backup": "string", Backup cloned address (S2)

      
"primary": "string" Primary cloned address (S1)

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLONE-JOIN - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/mofrr/clone-joins/clone-join/{source primary backup prefix-length}/

Create operation of resource: clone-join

clone-join_schema

clone-joinbody object

vrf-name: string
in path

ID of vrf-name

source primary backup prefix-length: string
in path

ID of source primary backup prefix-length

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"source": "string", Original source address (S)

      
"prefix-length": "string", Mask length

      
"backup": "string", Backup cloned address (S2)

      
"primary": "string" Primary cloned address (S1)

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLONE-JOIN - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/mofrr/clone-joins/clone-join/{source primary backup prefix-length}/

Delete operation of resource: clone-join

vrf-name: string
in path

ID of vrf-name

source primary backup prefix-length: string
in path

ID of source primary backup prefix-length

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLONE-JOIN - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/mofrr/clone-joins/clone-join/{source primary backup prefix-length}/

Retrieve operation of resource: clone-join

vrf-name: string
in path

ID of vrf-name

source primary backup prefix-length: string
in path

ID of source primary backup prefix-length

200 OK
clone-join_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"source": "string", Original source address (S)

      
"prefix-length": "string", Mask length

      
"backup": "string", Backup cloned address (S2)

      
"primary": "string" Primary cloned address (S1)

    }
  ]
}

CLONE-SOURCES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/mofrr/clone-sources/

Update operation of resource: clone-sources

clone-sources_schema

clone-sourcesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Clone multicast trafficPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"source": "string", Original source address (S)

        
"prefix-length": "string", Mask length

        
"backup": "string", Backup cloned address (S2)

        
"primary": "string" Primary cloned address (S1)

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLONE-SOURCES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/mofrr/clone-sources/

Create operation of resource: clone-sources

clone-sources_schema

clone-sourcesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Clone multicast trafficPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"source": "string", Original source address (S)

        
"prefix-length": "string", Mask length

        
"backup": "string", Backup cloned address (S2)

        
"primary": "string" Primary cloned address (S1)

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLONE-SOURCES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/mofrr/clone-sources/

Delete operation of resource: clone-sources

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLONE-SOURCES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/mofrr/clone-sources/

Retrieve operation of resource: clone-sources

vrf-name: string
in path

ID of vrf-name

200 OK
clone-sources_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Clone multicast trafficPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"source": "string", Original source address (S)

        
"prefix-length": "string", Mask length

        
"backup": "string", Backup cloned address (S2)

        
"primary": "string" Primary cloned address (S1)

      }
    ]
  }
}

CLONE-SOURCE - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/mofrr/clone-sources/clone-source/{source primary backup prefix-length}/

Update operation of resource: clone-source

clone-source_schema

clone-sourcebody object

vrf-name: string
in path

ID of vrf-name

source primary backup prefix-length: string
in path

ID of source primary backup prefix-length

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"source": "string", Original source address (S)

      
"prefix-length": "string", Mask length

      
"backup": "string", Backup cloned address (S2)

      
"primary": "string" Primary cloned address (S1)

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLONE-SOURCE - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/mofrr/clone-sources/clone-source/{source primary backup prefix-length}/

Create operation of resource: clone-source

clone-source_schema

clone-sourcebody object

vrf-name: string
in path

ID of vrf-name

source primary backup prefix-length: string
in path

ID of source primary backup prefix-length

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"source": "string", Original source address (S)

      
"prefix-length": "string", Mask length

      
"backup": "string", Backup cloned address (S2)

      
"primary": "string" Primary cloned address (S1)

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLONE-SOURCE - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/mofrr/clone-sources/clone-source/{source primary backup prefix-length}/

Delete operation of resource: clone-source

vrf-name: string
in path

ID of vrf-name

source primary backup prefix-length: string
in path

ID of source primary backup prefix-length

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLONE-SOURCE - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/mofrr/clone-sources/clone-source/{source primary backup prefix-length}/

Retrieve operation of resource: clone-source

vrf-name: string
in path

ID of vrf-name

source primary backup prefix-length: string
in path

ID of source primary backup prefix-length

200 OK
clone-source_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"source": "string", Original source address (S)

      
"prefix-length": "string", Mask length

      
"backup": "string", Backup cloned address (S2)

      
"primary": "string" Primary cloned address (S1)

    }
  ]
}

PATHS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/paths/

Update operation of resource: paths

paths_schema

pathsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"rpf-proxy-address": "string", RPF Proxy Address

        
"prefix-length": "string", Masklen

        
"source-address": "string" Source Address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PATHS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/paths/

Create operation of resource: paths

paths_schema

pathsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"rpf-proxy-address": "string", RPF Proxy Address

        
"prefix-length": "string", Masklen

        
"source-address": "string" Source Address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PATHS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/paths/

Delete operation of resource: paths

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PATHS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/paths/

Retrieve operation of resource: paths

vrf-name: string
in path

ID of vrf-name

200 OK
paths_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"rpf-proxy-address": "string", RPF Proxy Address

        
"prefix-length": "string", Masklen

        
"source-address": "string" Source Address

      }
    ]
  }
}

PATH - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/paths/path/{source-address prefix-length}/

Update operation of resource: path

path_schema

pathbody object

vrf-name: string
in path

ID of vrf-name

source-address prefix-length: string
in path

ID of source-address prefix-length

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"rpf-proxy-address": "string", RPF Proxy Address

      
"prefix-length": "string", Masklen

      
"source-address": "string" Source Address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PATH - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/paths/path/{source-address prefix-length}/

Create operation of resource: path

path_schema

pathbody object

vrf-name: string
in path

ID of vrf-name

source-address prefix-length: string
in path

ID of source-address prefix-length

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"rpf-proxy-address": "string", RPF Proxy Address

      
"prefix-length": "string", Masklen

      
"source-address": "string" Source Address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PATH - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/paths/path/{source-address prefix-length}/

Delete operation of resource: path

vrf-name: string
in path

ID of vrf-name

source-address prefix-length: string
in path

ID of source-address prefix-length

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PATH - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/paths/path/{source-address prefix-length}/

Retrieve operation of resource: path

vrf-name: string
in path

ID of vrf-name

source-address prefix-length: string
in path

ID of source-address prefix-length

200 OK
path_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"rpf-proxy-address": "string", RPF Proxy Address

      
"prefix-length": "string", Masklen

      
"source-address": "string" Source Address

    }
  ]
}

ALLOW-RP - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/allow-rp/

Update operation of resource: allow-rp

allow-rp_schema

allow-rpbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
    
"rp-list-name": "string", Access-list specifiying applicable RPs

    
"group-list-name": "string" Access-list specifiying applicable groups

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ALLOW-RP - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/allow-rp/

Create operation of resource: allow-rp

allow-rp_schema

allow-rpbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
    
"rp-list-name": "string", Access-list specifiying applicable RPs

    
"group-list-name": "string" Access-list specifiying applicable groups

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ALLOW-RP - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/allow-rp/

Delete operation of resource: allow-rp

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ALLOW-RP - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/allow-rp/

Retrieve operation of resource: allow-rp

vrf-name: string
in path

ID of vrf-name

200 OK
allow-rp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
    
"rp-list-name": "string", Access-list specifiying applicable RPs

    
"group-list-name": "string" Access-list specifiying applicable groups

  }
}

CONVERGENCE - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/convergence/

Update operation of resource: convergence

convergence_schema

convergencebody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure convergence parametersPUTPOSTDELETEGET
    
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

    
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONVERGENCE - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/convergence/

Create operation of resource: convergence

convergence_schema

convergencebody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure convergence parametersPUTPOSTDELETEGET
    
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

    
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONVERGENCE - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/convergence/

Delete operation of resource: convergence

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONVERGENCE - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/convergence/

Retrieve operation of resource: convergence

vrf-name: string
in path

ID of vrf-name

200 OK
convergence_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure convergence parametersPUTPOSTDELETEGET
    
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

    
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

  }
}

INTERFACES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/interfaces/

Update operation of resource: interfaces

interfaces_schema

interfacesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Interface-level ConfigurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only
          
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

          
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

          
"bundle-name": "string" Bundle name

        },
        
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

        
"interface-name": "string", The name of interface
        : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

          
"access-list-name": "string" Access-list to account for

        },
        : {
BFD configurationPUTPOSTDELETEGET
          
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

          
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

        },
        
"neighbor-filter": "string", Access-list of neighbors to be filtered

        
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

        
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

        
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

        
"interface-enable": "boolean", Enable PIM processing on the interface

        
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

        
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

        
"bsr-border": "boolean" BSR Border configuration for Interface

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/interfaces/

Create operation of resource: interfaces

interfaces_schema

interfacesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Interface-level ConfigurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only
          
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

          
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

          
"bundle-name": "string" Bundle name

        },
        
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

        
"interface-name": "string", The name of interface
        : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

          
"access-list-name": "string" Access-list to account for

        },
        : {
BFD configurationPUTPOSTDELETEGET
          
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

          
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

        },
        
"neighbor-filter": "string", Access-list of neighbors to be filtered

        
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

        
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

        
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

        
"interface-enable": "boolean", Enable PIM processing on the interface

        
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

        
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

        
"bsr-border": "boolean" BSR Border configuration for Interface

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/interfaces/

Delete operation of resource: interfaces

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/interfaces/

Retrieve operation of resource: interfaces

vrf-name: string
in path

ID of vrf-name

200 OK
interfaces_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Interface-level ConfigurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only
          
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

          
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

          
"bundle-name": "string" Bundle name

        },
        
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

        
"interface-name": "string", The name of interface
        : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

          
"access-list-name": "string" Access-list to account for

        },
        : {
BFD configurationPUTPOSTDELETEGET
          
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

          
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

        },
        
"neighbor-filter": "string", Access-list of neighbors to be filtered

        
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

        
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

        
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

        
"interface-enable": "boolean", Enable PIM processing on the interface

        
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

        
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

        
"bsr-border": "boolean" BSR Border configuration for Interface

      }
    ]
  }
}

INTERFACE - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/interfaces/interface/{interface-name}/

Update operation of resource: interface

interface_schema

interfacebody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only
        
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

        
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

        
"bundle-name": "string" Bundle name

      },
      
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

      
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

      
"interface-name": "string", The name of interface
      : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

        
"access-list-name": "string" Access-list to account for

      },
      : {
BFD configurationPUTPOSTDELETEGET
        
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

        
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

      },
      
"neighbor-filter": "string", Access-list of neighbors to be filtered

      
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

      
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

      
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

      
"interface-enable": "boolean", Enable PIM processing on the interface

      
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

      
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

      
"bsr-border": "boolean" BSR Border configuration for Interface

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/interfaces/interface/{interface-name}/

Create operation of resource: interface

interface_schema

interfacebody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only
        
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

        
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

        
"bundle-name": "string" Bundle name

      },
      
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

      
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

      
"interface-name": "string", The name of interface
      : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

        
"access-list-name": "string" Access-list to account for

      },
      : {
BFD configurationPUTPOSTDELETEGET
        
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

        
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

      },
      
"neighbor-filter": "string", Access-list of neighbors to be filtered

      
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

      
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

      
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

      
"interface-enable": "boolean", Enable PIM processing on the interface

      
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

      
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

      
"bsr-border": "boolean" BSR Border configuration for Interface

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/interfaces/interface/{interface-name}/

Delete operation of resource: interface

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/interfaces/interface/{interface-name}/

Retrieve operation of resource: interface

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK
interface_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only
        
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

        
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

        
"bundle-name": "string" Bundle name

      },
      
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

      
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

      
"interface-name": "string", The name of interface
      : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

        
"access-list-name": "string" Access-list to account for

      },
      : {
BFD configurationPUTPOSTDELETEGET
        
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

        
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

      },
      
"neighbor-filter": "string", Access-list of neighbors to be filtered

      
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

      
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

      
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

      
"interface-enable": "boolean", Enable PIM processing on the interface

      
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

      
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

      
"bsr-border": "boolean" BSR Border configuration for Interface

    }
  ]
}

MAXIMUM-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/interfaces/interface/{interface-name}/maximum-routes/

Update operation of resource: maximum-routes

maximum-routes_schema

maximum-routesbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

    
"access-list-name": "string" Access-list to account for

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-ROUTES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/interfaces/interface/{interface-name}/maximum-routes/

Create operation of resource: maximum-routes

maximum-routes_schema

maximum-routesbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

    
"access-list-name": "string" Access-list to account for

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/interfaces/interface/{interface-name}/maximum-routes/

Delete operation of resource: maximum-routes

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/interfaces/interface/{interface-name}/maximum-routes/

Retrieve operation of resource: maximum-routes

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK
maximum-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

    
"access-list-name": "string" Access-list to account for

  }
}

BFD - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/interfaces/interface/{interface-name}/bfd/

Update operation of resource: bfd

bfd_schema

bfdbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
BFD configurationPUTPOSTDELETEGET
    
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

    
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

    
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BFD - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/interfaces/interface/{interface-name}/bfd/

Create operation of resource: bfd

bfd_schema

bfdbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
BFD configurationPUTPOSTDELETEGET
    
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

    
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

    
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BFD - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/interfaces/interface/{interface-name}/bfd/

Delete operation of resource: bfd

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BFD - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv4/interfaces/interface/{interface-name}/bfd/

Retrieve operation of resource: bfd

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK
bfd_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
BFD configurationPUTPOSTDELETEGET
    
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

    
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

    
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

  }
}

IPV6 - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/

Update operation of resource: ipv6

ipv6_schema

ipv6body object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
IPV6 commandsPUTPOSTDELETEGET
    : {
Configure Non-stop forwarding (NSF) options
      
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

    },
    : {
Configure convergence parametersPUTPOSTDELETEGET
      
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

      
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

    },
    
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
    : {
Configure RPF optionsPUTPOSTDELETEGET
      
"route-policy": "string" Route policy to select RPF topology

    },
    
"multipath": "string", Enable equal-cost multipath routing

    
"register-source": "string", Source address to use for register messages

    
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages

    
"neighbor-filter": "string", Access-list of neighbors to be filtered
    : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

          
"rp-address": "string", RP address of Rendezvous Point

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        }
      ]
    },
    
"accept-register": "string", Access-list which specifies unauthorized sources
    : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
      
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    },
    
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
    : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
      
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

      
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

      
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

    },
    : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
      
"rp-list-name": "string", Access-list specifiying applicable RPs

      
"group-list-name": "string" Access-list specifiying applicable groups

    },
    
"embedded-rp-disable": "null", Set Embedded RP processing support

    
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

    
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
    : {
Interface-level ConfigurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"neighbor-filter": "string", Access-list of neighbors to be filtered

          
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

          
"interface-name": "string", The name of interface
          : {
Maximum number of PIM routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          },
          : {
BFD configurationPUTPOSTDELETEGET
            
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

            
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

            
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

          },
          
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

          
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

          
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

          
"interface-enable": "boolean", Enable PIM processing on the interface

          
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

          
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

          
"bsr-border": "boolean" BSR Border configuration for Interface

        }
      ]
    },
    : {
Set Embedded RP processing supportPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"rp-address": "string", RP address of Rendezvous Point

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        }
      ]
    },
    : {
PIM BSR configurationPUTPOSTDELETEGET
      : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
        
"priority": "string", Priority of the CRP

        
"prefix-length": "string", Hash Mask Length for this candidate BSR

        
"address": "string" Address of Candidate-RP

      },
      : {
PIM RP configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

            
"priority": "string", Priority of the CRP

            
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

            
"mode": "string", SM or Bidir

            
"address": "string" Address of Candidate-RP

          }
        ]
      }
    },
    : {
Configure IP Multicast SSMPUTPOSTDELETEGET
      
"range": "string", Access list of groups enabled with SSM

      
"disable": "boolean" TRUE if SSM is disabled on this router

    },
    
"rp-static-deny": "string", Configure static RP deny range

    
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
    : {
Inheritable defaultsPUTPOSTDELETEGET
      
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

      
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

      
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

      
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

      
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

      
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

      
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

    },
    : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

          
"rp-address": "string", RP address of Rendezvous Point

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        }
      ]
    },
    
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
    : {
Configure PIM State LimitsPUTPOSTDELETEGET
      
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
      : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
        
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

        
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

      },
      : {
Maximum for number of group mappings from\nautorp mapping agent
        
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

        
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

      },
      : {
Override default maximum for number of\nsparse-mode source registers
        
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

      },
      : {
Override default maximum for number of routes
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

      },
      : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
        
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum for number of\nroute-interfaces
        
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSR
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

      },
      
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
      : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
        
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum for number of routesPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

      },
      : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
        
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default global maximum and threshold\nfor C-RP set in BSR
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

      }
    },
    
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/

Create operation of resource: ipv6

ipv6_schema

ipv6body object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
IPV6 commandsPUTPOSTDELETEGET
    : {
Configure Non-stop forwarding (NSF) options
      
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

    },
    : {
Configure convergence parametersPUTPOSTDELETEGET
      
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

      
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

    },
    
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
    : {
Configure RPF optionsPUTPOSTDELETEGET
      
"route-policy": "string" Route policy to select RPF topology

    },
    
"multipath": "string", Enable equal-cost multipath routing

    
"register-source": "string", Source address to use for register messages

    
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages

    
"neighbor-filter": "string", Access-list of neighbors to be filtered
    : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

          
"rp-address": "string", RP address of Rendezvous Point

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        }
      ]
    },
    
"accept-register": "string", Access-list which specifies unauthorized sources
    : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
      
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    },
    
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
    : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
      
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

      
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

      
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

    },
    : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
      
"rp-list-name": "string", Access-list specifiying applicable RPs

      
"group-list-name": "string" Access-list specifiying applicable groups

    },
    
"embedded-rp-disable": "null", Set Embedded RP processing support

    
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

    
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
    : {
Interface-level ConfigurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"neighbor-filter": "string", Access-list of neighbors to be filtered

          
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

          
"interface-name": "string", The name of interface
          : {
Maximum number of PIM routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          },
          : {
BFD configurationPUTPOSTDELETEGET
            
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

            
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

            
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

          },
          
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

          
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

          
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

          
"interface-enable": "boolean", Enable PIM processing on the interface

          
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

          
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

          
"bsr-border": "boolean" BSR Border configuration for Interface

        }
      ]
    },
    : {
Set Embedded RP processing supportPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"rp-address": "string", RP address of Rendezvous Point

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        }
      ]
    },
    : {
PIM BSR configurationPUTPOSTDELETEGET
      : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
        
"priority": "string", Priority of the CRP

        
"prefix-length": "string", Hash Mask Length for this candidate BSR

        
"address": "string" Address of Candidate-RP

      },
      : {
PIM RP configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

            
"priority": "string", Priority of the CRP

            
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

            
"mode": "string", SM or Bidir

            
"address": "string" Address of Candidate-RP

          }
        ]
      }
    },
    : {
Configure IP Multicast SSMPUTPOSTDELETEGET
      
"range": "string", Access list of groups enabled with SSM

      
"disable": "boolean" TRUE if SSM is disabled on this router

    },
    
"rp-static-deny": "string", Configure static RP deny range

    
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
    : {
Inheritable defaultsPUTPOSTDELETEGET
      
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

      
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

      
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

      
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

      
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

      
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

      
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

    },
    : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

          
"rp-address": "string", RP address of Rendezvous Point

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        }
      ]
    },
    
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
    : {
Configure PIM State LimitsPUTPOSTDELETEGET
      
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
      : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
        
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

        
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

      },
      : {
Maximum for number of group mappings from\nautorp mapping agent
        
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

        
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

      },
      : {
Override default maximum for number of\nsparse-mode source registers
        
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

      },
      : {
Override default maximum for number of routes
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

      },
      : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
        
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum for number of\nroute-interfaces
        
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSR
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

      },
      
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
      : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
        
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum for number of routesPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

      },
      : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
        
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default global maximum and threshold\nfor C-RP set in BSR
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

      }
    },
    
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/

Delete operation of resource: ipv6

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/

Retrieve operation of resource: ipv6

vrf-name: string
in path

ID of vrf-name

200 OK
ipv6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IPV6 commandsPUTPOSTDELETEGET
    : {
Configure Non-stop forwarding (NSF) options
      
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

    },
    : {
Configure convergence parametersPUTPOSTDELETEGET
      
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

      
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

    },
    
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
    : {
Configure RPF optionsPUTPOSTDELETEGET
      
"route-policy": "string" Route policy to select RPF topology

    },
    
"multipath": "string", Enable equal-cost multipath routing

    
"register-source": "string", Source address to use for register messages

    
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages

    
"neighbor-filter": "string", Access-list of neighbors to be filtered
    : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

          
"rp-address": "string", RP address of Rendezvous Point

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        }
      ]
    },
    
"accept-register": "string", Access-list which specifies unauthorized sources
    : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
      
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    },
    
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
    : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
      
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

      
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

      
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

    },
    : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
      
"rp-list-name": "string", Access-list specifiying applicable RPs

      
"group-list-name": "string" Access-list specifiying applicable groups

    },
    
"embedded-rp-disable": "null", Set Embedded RP processing support

    
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

    
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
    : {
Interface-level ConfigurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"neighbor-filter": "string", Access-list of neighbors to be filtered

          
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

          
"interface-name": "string", The name of interface
          : {
Maximum number of PIM routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          },
          : {
BFD configurationPUTPOSTDELETEGET
            
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

            
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

            
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

          },
          
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

          
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

          
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

          
"interface-enable": "boolean", Enable PIM processing on the interface

          
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

          
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

          
"bsr-border": "boolean" BSR Border configuration for Interface

        }
      ]
    },
    : {
Set Embedded RP processing supportPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"rp-address": "string", RP address of Rendezvous Point

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        }
      ]
    },
    : {
PIM BSR configurationPUTPOSTDELETEGET
      : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
        
"priority": "string", Priority of the CRP

        
"prefix-length": "string", Hash Mask Length for this candidate BSR

        
"address": "string" Address of Candidate-RP

      },
      : {
PIM RP configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

            
"priority": "string", Priority of the CRP

            
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

            
"mode": "string", SM or Bidir

            
"address": "string" Address of Candidate-RP

          }
        ]
      }
    },
    : {
Configure IP Multicast SSMPUTPOSTDELETEGET
      
"range": "string", Access list of groups enabled with SSM

      
"disable": "boolean" TRUE if SSM is disabled on this router

    },
    
"rp-static-deny": "string", Configure static RP deny range

    
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
    : {
Inheritable defaultsPUTPOSTDELETEGET
      
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

      
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

      
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

      
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

      
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

      
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

      
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

    },
    : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

          
"rp-address": "string", RP address of Rendezvous Point

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        }
      ]
    },
    
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
    : {
Configure PIM State LimitsPUTPOSTDELETEGET
      
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
      : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
        
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

        
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

      },
      : {
Maximum for number of group mappings from\nautorp mapping agent
        
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

        
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

      },
      : {
Override default maximum for number of\nsparse-mode source registers
        
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

      },
      : {
Override default maximum for number of routes
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

      },
      : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
        
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum for number of\nroute-interfaces
        
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSR
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

      },
      
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
      : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
        
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum for number of routesPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

      },
      : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
        
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default global maximum and threshold\nfor C-RP set in BSR
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

      }
    },
    
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

  }
}

SPARSE-MODE-RP-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/sparse-mode-rp-addresses/

Update operation of resource: sparse-mode-rp-addresses

sparse-mode-rp-addresses_schema

sparse-mode-rp-addressesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

        
"rp-address": "string", RP address of Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SPARSE-MODE-RP-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/sparse-mode-rp-addresses/

Create operation of resource: sparse-mode-rp-addresses

sparse-mode-rp-addresses_schema

sparse-mode-rp-addressesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

        
"rp-address": "string", RP address of Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SPARSE-MODE-RP-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/sparse-mode-rp-addresses/

Delete operation of resource: sparse-mode-rp-addresses

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SPARSE-MODE-RP-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/sparse-mode-rp-addresses/

Retrieve operation of resource: sparse-mode-rp-addresses

vrf-name: string
in path

ID of vrf-name

200 OK
sparse-mode-rp-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

        
"rp-address": "string", RP address of Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}

SPARSE-MODE-RP-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/sparse-mode-rp-addresses/sparse-mode-rp-address/{rp-address}/

Update operation of resource: sparse-mode-rp-address

sparse-mode-rp-address_schema

sparse-mode-rp-addressbody object

vrf-name: string
in path

ID of vrf-name

rp-address: string
in path

ID of rp-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

      
"rp-address": "string", RP address of Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SPARSE-MODE-RP-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/sparse-mode-rp-addresses/sparse-mode-rp-address/{rp-address}/

Create operation of resource: sparse-mode-rp-address

sparse-mode-rp-address_schema

sparse-mode-rp-addressbody object

vrf-name: string
in path

ID of vrf-name

rp-address: string
in path

ID of rp-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

      
"rp-address": "string", RP address of Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SPARSE-MODE-RP-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/sparse-mode-rp-addresses/sparse-mode-rp-address/{rp-address}/

Delete operation of resource: sparse-mode-rp-address

vrf-name: string
in path

ID of vrf-name

rp-address: string
in path

ID of rp-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SPARSE-MODE-RP-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/sparse-mode-rp-addresses/sparse-mode-rp-address/{rp-address}/

Retrieve operation of resource: sparse-mode-rp-address

vrf-name: string
in path

ID of vrf-name

rp-address: string
in path

ID of rp-address

200 OK
sparse-mode-rp-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

      
"rp-address": "string", RP address of Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}

INHERITABLE-DEFAULTS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/inheritable-defaults/

Update operation of resource: inheritable-defaults

inheritable-defaults_schema

inheritable-defaultsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Inheritable defaultsPUTPOSTDELETEGET
    
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

    
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

    
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

    
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

    
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

    
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

    
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERITABLE-DEFAULTS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/inheritable-defaults/

Create operation of resource: inheritable-defaults

inheritable-defaults_schema

inheritable-defaultsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Inheritable defaultsPUTPOSTDELETEGET
    
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

    
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

    
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

    
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

    
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

    
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

    
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERITABLE-DEFAULTS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/inheritable-defaults/

Delete operation of resource: inheritable-defaults

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERITABLE-DEFAULTS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/inheritable-defaults/

Retrieve operation of resource: inheritable-defaults

vrf-name: string
in path

ID of vrf-name

200 OK
inheritable-defaults_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Inheritable defaultsPUTPOSTDELETEGET
    
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

    
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

    
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

    
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

    
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

    
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

    
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

  }
}

RPF - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/rpf/

Update operation of resource: rpf

rpf_schema

rpfbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure RPF optionsPUTPOSTDELETEGET
    
"route-policy": "string" Route policy to select RPF topology

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/rpf/

Create operation of resource: rpf

rpf_schema

rpfbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure RPF optionsPUTPOSTDELETEGET
    
"route-policy": "string" Route policy to select RPF topology

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/rpf/

Delete operation of resource: rpf

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/rpf/

Retrieve operation of resource: rpf

vrf-name: string
in path

ID of vrf-name

200 OK
rpf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure RPF optionsPUTPOSTDELETEGET
    
"route-policy": "string" Route policy to select RPF topology

  }
}

MAXIMUM - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/

Update operation of resource: maximum

maximum_schema

maximumbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure PIM State LimitsPUTPOSTDELETEGET
    
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
    : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
      
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

      
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

    },
    : {
Maximum for number of group mappings from\nautorp mapping agent
      
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

      
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

    },
    : {
Override default maximum for number of\nsparse-mode source registers
      
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

    },
    : {
Override default maximum for number of routes
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

    },
    : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
      
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum for number of\nroute-interfaces
      
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSR
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

    },
    
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
    : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
      
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum for number of routesPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

    },
    : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
      
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default global maximum and threshold\nfor C-RP set in BSR
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/

Create operation of resource: maximum

maximum_schema

maximumbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure PIM State LimitsPUTPOSTDELETEGET
    
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
    : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
      
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

      
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

    },
    : {
Maximum for number of group mappings from\nautorp mapping agent
      
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

      
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

    },
    : {
Override default maximum for number of\nsparse-mode source registers
      
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

    },
    : {
Override default maximum for number of routes
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

    },
    : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
      
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum for number of\nroute-interfaces
      
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSR
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

    },
    
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
    : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
      
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum for number of routesPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

    },
    : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
      
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default global maximum and threshold\nfor C-RP set in BSR
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/

Delete operation of resource: maximum

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/

Retrieve operation of resource: maximum

vrf-name: string
in path

ID of vrf-name

200 OK
maximum_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure PIM State LimitsPUTPOSTDELETEGET
    
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
    : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
      
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

      
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

    },
    : {
Maximum for number of group mappings from\nautorp mapping agent
      
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

      
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

    },
    : {
Override default maximum for number of\nsparse-mode source registers
      
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

    },
    : {
Override default maximum for number of routes
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

    },
    : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
      
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum for number of\nroute-interfaces
      
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSR
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

    },
    
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
    : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
      
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum for number of routesPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

    },
    : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
      
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default global maximum and threshold\nfor C-RP set in BSR
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

    }
  }
}

GROUP-MAPPINGS-AUTO-RP - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/group-mappings-auto-rp/

Update operation of resource: group-mappings-auto-rp

group-mappings-auto-rp_schema

group-mappings-auto-rpbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
    
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

    
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-MAPPINGS-AUTO-RP - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/group-mappings-auto-rp/

Create operation of resource: group-mappings-auto-rp

group-mappings-auto-rp_schema

group-mappings-auto-rpbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
    
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

    
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-MAPPINGS-AUTO-RP - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/group-mappings-auto-rp/

Delete operation of resource: group-mappings-auto-rp

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-MAPPINGS-AUTO-RP - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/group-mappings-auto-rp/

Retrieve operation of resource: group-mappings-auto-rp

vrf-name: string
in path

ID of vrf-name

200 OK
group-mappings-auto-rp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
    
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

    
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

  }
}

BSR-GROUP-MAPPINGS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/bsr-group-mappings/

Update operation of resource: bsr-group-mappings

bsr-group-mappings_schema

bsr-group-mappingsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-GROUP-MAPPINGS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/bsr-group-mappings/

Create operation of resource: bsr-group-mappings

bsr-group-mappings_schema

bsr-group-mappingsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-GROUP-MAPPINGS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/bsr-group-mappings/

Delete operation of resource: bsr-group-mappings

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-GROUP-MAPPINGS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/bsr-group-mappings/

Retrieve operation of resource: bsr-group-mappings

vrf-name: string
in path

ID of vrf-name

200 OK
bsr-group-mappings_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

  }
}

REGISTER-STATES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/register-states/

Update operation of resource: register-states

register-states_schema

register-statesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
    
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REGISTER-STATES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/register-states/

Create operation of resource: register-states

register-states_schema

register-statesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
    
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REGISTER-STATES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/register-states/

Delete operation of resource: register-states

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REGISTER-STATES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/register-states/

Retrieve operation of resource: register-states

vrf-name: string
in path

ID of vrf-name

200 OK
register-states_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
    
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}

ROUTE-INTERFACES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/route-interfaces/

Update operation of resource: route-interfaces

route-interfaces_schema

route-interfacesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
    
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTE-INTERFACES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/route-interfaces/

Create operation of resource: route-interfaces

route-interfaces_schema

route-interfacesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
    
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTE-INTERFACES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/route-interfaces/

Delete operation of resource: route-interfaces

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTE-INTERFACES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/route-interfaces/

Retrieve operation of resource: route-interfaces

vrf-name: string
in path

ID of vrf-name

200 OK
route-interfaces_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
    
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}

BSR-CANDIDATE-RP-CACHE - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/bsr-candidate-rp-cache/

Update operation of resource: bsr-candidate-rp-cache

bsr-candidate-rp-cache_schema

bsr-candidate-rp-cachebody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
    
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-CANDIDATE-RP-CACHE - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/bsr-candidate-rp-cache/

Create operation of resource: bsr-candidate-rp-cache

bsr-candidate-rp-cache_schema

bsr-candidate-rp-cachebody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
    
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-CANDIDATE-RP-CACHE - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/bsr-candidate-rp-cache/

Delete operation of resource: bsr-candidate-rp-cache

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-CANDIDATE-RP-CACHE - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/bsr-candidate-rp-cache/

Retrieve operation of resource: bsr-candidate-rp-cache

vrf-name: string
in path

ID of vrf-name

200 OK
bsr-candidate-rp-cache_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
    
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}

ROUTES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/routes/

Update operation of resource: routes

routes_schema

routesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of routesPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/routes/

Create operation of resource: routes

routes_schema

routesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of routesPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/routes/

Delete operation of resource: routes

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/maximum/routes/

Retrieve operation of resource: routes

vrf-name: string
in path

ID of vrf-name

200 OK
routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum for number of routesPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

  }
}

SG-EXPIRY-TIMER - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/sg-expiry-timer/

Update operation of resource: sg-expiry-timer

sg-expiry-timer_schema

sg-expiry-timerbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
    
"interval": "integer", (S,G) expiry time in seconds
range: "30..600"
units: "second"
default: "60"

    
"access-list-name": "string" Access-list of applicable S,G routes

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SG-EXPIRY-TIMER - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/sg-expiry-timer/

Create operation of resource: sg-expiry-timer

sg-expiry-timer_schema

sg-expiry-timerbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
    
"interval": "integer", (S,G) expiry time in seconds
range: "30..600"
units: "second"
default: "60"

    
"access-list-name": "string" Access-list of applicable S,G routes

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SG-EXPIRY-TIMER - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/sg-expiry-timer/

Delete operation of resource: sg-expiry-timer

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SG-EXPIRY-TIMER - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/sg-expiry-timer/

Retrieve operation of resource: sg-expiry-timer

vrf-name: string
in path

ID of vrf-name

200 OK
sg-expiry-timer_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
    
"interval": "integer", (S,G) expiry time in seconds
range: "30..600"
units: "second"
default: "60"

    
"access-list-name": "string" Access-list of applicable S,G routes

  }
}

RPF-VECTOR-ENABLE - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/rpf-vector-enable/

Update operation of resource: rpf-vector-enable

rpf-vector-enable_schema

rpf-vector-enablebody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
    
"enable": "null", RPF Vector is turned on if configured

    
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

    
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF-VECTOR-ENABLE - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/rpf-vector-enable/

Create operation of resource: rpf-vector-enable

rpf-vector-enable_schema

rpf-vector-enablebody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
    
"enable": "null", RPF Vector is turned on if configured

    
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

    
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF-VECTOR-ENABLE - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/rpf-vector-enable/

Delete operation of resource: rpf-vector-enable

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF-VECTOR-ENABLE - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/rpf-vector-enable/

Retrieve operation of resource: rpf-vector-enable

vrf-name: string
in path

ID of vrf-name

200 OK
rpf-vector-enable_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
    
"enable": "null", RPF Vector is turned on if configured

    
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

    
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

  }
}

SSM - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/ssm/

Update operation of resource: ssm

ssm_schema

ssmbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure IP Multicast SSMPUTPOSTDELETEGET
    
"range": "string", Access list of groups enabled with SSM

    
"disable": "boolean" TRUE if SSM is disabled on this router

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/ssm/

Create operation of resource: ssm

ssm_schema

ssmbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure IP Multicast SSMPUTPOSTDELETEGET
    
"range": "string", Access list of groups enabled with SSM

    
"disable": "boolean" TRUE if SSM is disabled on this router

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/ssm/

Delete operation of resource: ssm

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/ssm/

Retrieve operation of resource: ssm

vrf-name: string
in path

ID of vrf-name

200 OK
ssm_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure IP Multicast SSMPUTPOSTDELETEGET
    
"range": "string", Access list of groups enabled with SSM

    
"disable": "boolean" TRUE if SSM is disabled on this router

  }
}

BIDIR-RP-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/bidir-rp-addresses/

Update operation of resource: bidir-rp-addresses

bidir-rp-addresses_schema

bidir-rp-addressesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

        
"rp-address": "string", RP address of Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BIDIR-RP-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/bidir-rp-addresses/

Create operation of resource: bidir-rp-addresses

bidir-rp-addresses_schema

bidir-rp-addressesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

        
"rp-address": "string", RP address of Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BIDIR-RP-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/bidir-rp-addresses/

Delete operation of resource: bidir-rp-addresses

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BIDIR-RP-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/bidir-rp-addresses/

Retrieve operation of resource: bidir-rp-addresses

vrf-name: string
in path

ID of vrf-name

200 OK
bidir-rp-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

        
"rp-address": "string", RP address of Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}

BIDIR-RP-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/bidir-rp-addresses/bidir-rp-address/{rp-address}/

Update operation of resource: bidir-rp-address

bidir-rp-address_schema

bidir-rp-addressbody object

vrf-name: string
in path

ID of vrf-name

rp-address: string
in path

ID of rp-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

      
"rp-address": "string", RP address of Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BIDIR-RP-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/bidir-rp-addresses/bidir-rp-address/{rp-address}/

Create operation of resource: bidir-rp-address

bidir-rp-address_schema

bidir-rp-addressbody object

vrf-name: string
in path

ID of vrf-name

rp-address: string
in path

ID of rp-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

      
"rp-address": "string", RP address of Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BIDIR-RP-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/bidir-rp-addresses/bidir-rp-address/{rp-address}/

Delete operation of resource: bidir-rp-address

vrf-name: string
in path

ID of vrf-name

rp-address: string
in path

ID of rp-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BIDIR-RP-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/bidir-rp-addresses/bidir-rp-address/{rp-address}/

Retrieve operation of resource: bidir-rp-address

vrf-name: string
in path

ID of vrf-name

rp-address: string
in path

ID of rp-address

200 OK
bidir-rp-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

      
"rp-address": "string", RP address of Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}

BSR - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/bsr/

Update operation of resource: bsr

bsr_schema

bsrbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
PIM BSR configurationPUTPOSTDELETEGET
    : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
      
"priority": "string", Priority of the CRP

      
"prefix-length": "string", Hash Mask Length for this candidate BSR

      
"address": "string" Address of Candidate-RP

    },
    : {
PIM RP configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

          
"priority": "string", Priority of the CRP

          
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

          
"mode": "string", SM or Bidir

          
"address": "string" Address of Candidate-RP

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/bsr/

Create operation of resource: bsr

bsr_schema

bsrbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
PIM BSR configurationPUTPOSTDELETEGET
    : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
      
"priority": "string", Priority of the CRP

      
"prefix-length": "string", Hash Mask Length for this candidate BSR

      
"address": "string" Address of Candidate-RP

    },
    : {
PIM RP configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

          
"priority": "string", Priority of the CRP

          
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

          
"mode": "string", SM or Bidir

          
"address": "string" Address of Candidate-RP

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/bsr/

Delete operation of resource: bsr

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/bsr/

Retrieve operation of resource: bsr

vrf-name: string
in path

ID of vrf-name

200 OK
bsr_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
PIM BSR configurationPUTPOSTDELETEGET
    : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
      
"priority": "string", Priority of the CRP

      
"prefix-length": "string", Hash Mask Length for this candidate BSR

      
"address": "string" Address of Candidate-RP

    },
    : {
PIM RP configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

          
"priority": "string", Priority of the CRP

          
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

          
"mode": "string", SM or Bidir

          
"address": "string" Address of Candidate-RP

        }
      ]
    }
  }
}

CANDIDATE-BSR - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/bsr/candidate-bsr/

Update operation of resource: candidate-bsr

candidate-bsr_schema

candidate-bsrbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
    
"priority": "string", Priority of the Candidate BSR

    
"prefix-length": "string", Hash Mask Length for this candidate BSR

    
"address": "string" BSR Address configured

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-BSR - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/bsr/candidate-bsr/

Create operation of resource: candidate-bsr

candidate-bsr_schema

candidate-bsrbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
    
"priority": "string", Priority of the Candidate BSR

    
"prefix-length": "string", Hash Mask Length for this candidate BSR

    
"address": "string" BSR Address configured

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-BSR - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/bsr/candidate-bsr/

Delete operation of resource: candidate-bsr

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-BSR - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/bsr/candidate-bsr/

Retrieve operation of resource: candidate-bsr

vrf-name: string
in path

ID of vrf-name

200 OK
candidate-bsr_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
    
"priority": "string", Priority of the Candidate BSR

    
"prefix-length": "string", Hash Mask Length for this candidate BSR

    
"address": "string" BSR Address configured

  }
}

CANDIDATE-RPS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/bsr/candidate-rps/

Update operation of resource: candidate-rps

candidate-rps_schema

candidate-rpsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
PIM RP configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

        
"priority": "string", Priority of the CRP

        
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

        
"mode": "string", SM or Bidir

        
"address": "string" Address of Candidate-RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-RPS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/bsr/candidate-rps/

Create operation of resource: candidate-rps

candidate-rps_schema

candidate-rpsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
PIM RP configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

        
"priority": "string", Priority of the CRP

        
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

        
"mode": "string", SM or Bidir

        
"address": "string" Address of Candidate-RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-RPS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/bsr/candidate-rps/

Delete operation of resource: candidate-rps

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-RPS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/bsr/candidate-rps/

Retrieve operation of resource: candidate-rps

vrf-name: string
in path

ID of vrf-name

200 OK
candidate-rps_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
PIM RP configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

        
"priority": "string", Priority of the CRP

        
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

        
"mode": "string", SM or Bidir

        
"address": "string" Address of Candidate-RP

      }
    ]
  }
}

CANDIDATE-RP - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/bsr/candidate-rps/candidate-rp/{address mode}/

Update operation of resource: candidate-rp

candidate-rp_schema

candidate-rpbody object

vrf-name: string
in path

ID of vrf-name

address mode: string
in path

ID of address mode

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

      
"priority": "string", Priority of the CRP

      
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

      
"mode": "string", SM or Bidir

      
"address": "string" Address of Candidate-RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-RP - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/bsr/candidate-rps/candidate-rp/{address mode}/

Create operation of resource: candidate-rp

candidate-rp_schema

candidate-rpbody object

vrf-name: string
in path

ID of vrf-name

address mode: string
in path

ID of address mode

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

      
"priority": "string", Priority of the CRP

      
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

      
"mode": "string", SM or Bidir

      
"address": "string" Address of Candidate-RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-RP - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/bsr/candidate-rps/candidate-rp/{address mode}/

Delete operation of resource: candidate-rp

vrf-name: string
in path

ID of vrf-name

address mode: string
in path

ID of address mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-RP - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/bsr/candidate-rps/candidate-rp/{address mode}/

Retrieve operation of resource: candidate-rp

vrf-name: string
in path

ID of vrf-name

address mode: string
in path

ID of address mode

200 OK
candidate-rp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

      
"priority": "string", Priority of the CRP

      
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

      
"mode": "string", SM or Bidir

      
"address": "string" Address of Candidate-RP

    }
  ]
}

ALLOW-RP - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/allow-rp/

Update operation of resource: allow-rp

allow-rp_schema

allow-rpbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
    
"rp-list-name": "string", Access-list specifiying applicable RPs

    
"group-list-name": "string" Access-list specifiying applicable groups

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ALLOW-RP - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/allow-rp/

Create operation of resource: allow-rp

allow-rp_schema

allow-rpbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
    
"rp-list-name": "string", Access-list specifiying applicable RPs

    
"group-list-name": "string" Access-list specifiying applicable groups

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ALLOW-RP - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/allow-rp/

Delete operation of resource: allow-rp

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ALLOW-RP - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/allow-rp/

Retrieve operation of resource: allow-rp

vrf-name: string
in path

ID of vrf-name

200 OK
allow-rp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
    
"rp-list-name": "string", Access-list specifiying applicable RPs

    
"group-list-name": "string" Access-list specifiying applicable groups

  }
}

EMBEDDED-RP-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/embedded-rp-addresses/

Update operation of resource: embedded-rp-addresses

embedded-rp-addresses_schema

embedded-rp-addressesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Set Embedded RP processing supportPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"rp-address": "string", RP address of the Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EMBEDDED-RP-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/embedded-rp-addresses/

Create operation of resource: embedded-rp-addresses

embedded-rp-addresses_schema

embedded-rp-addressesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Set Embedded RP processing supportPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"rp-address": "string", RP address of the Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EMBEDDED-RP-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/embedded-rp-addresses/

Delete operation of resource: embedded-rp-addresses

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EMBEDDED-RP-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/embedded-rp-addresses/

Retrieve operation of resource: embedded-rp-addresses

vrf-name: string
in path

ID of vrf-name

200 OK
embedded-rp-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Set Embedded RP processing supportPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"rp-address": "string", RP address of the Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}

EMBEDDED-RP-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/embedded-rp-addresses/embedded-rp-address/{rp-address}/

Update operation of resource: embedded-rp-address

embedded-rp-address_schema

embedded-rp-addressbody object

vrf-name: string
in path

ID of vrf-name

rp-address: string
in path

ID of rp-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"rp-address": "string", RP address of the Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EMBEDDED-RP-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/embedded-rp-addresses/embedded-rp-address/{rp-address}/

Create operation of resource: embedded-rp-address

embedded-rp-address_schema

embedded-rp-addressbody object

vrf-name: string
in path

ID of vrf-name

rp-address: string
in path

ID of rp-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"rp-address": "string", RP address of the Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EMBEDDED-RP-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/embedded-rp-addresses/embedded-rp-address/{rp-address}/

Delete operation of resource: embedded-rp-address

vrf-name: string
in path

ID of vrf-name

rp-address: string
in path

ID of rp-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EMBEDDED-RP-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/embedded-rp-addresses/embedded-rp-address/{rp-address}/

Retrieve operation of resource: embedded-rp-address

vrf-name: string
in path

ID of vrf-name

rp-address: string
in path

ID of rp-address

200 OK
embedded-rp-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"rp-address": "string", RP address of the Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}

CONVERGENCE - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/convergence/

Update operation of resource: convergence

convergence_schema

convergencebody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure convergence parametersPUTPOSTDELETEGET
    
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

    
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONVERGENCE - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/convergence/

Create operation of resource: convergence

convergence_schema

convergencebody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure convergence parametersPUTPOSTDELETEGET
    
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

    
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONVERGENCE - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/convergence/

Delete operation of resource: convergence

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONVERGENCE - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/convergence/

Retrieve operation of resource: convergence

vrf-name: string
in path

ID of vrf-name

200 OK
convergence_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure convergence parametersPUTPOSTDELETEGET
    
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

    
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

  }
}

INTERFACES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/interfaces/

Update operation of resource: interfaces

interfaces_schema

interfacesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Interface-level ConfigurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only
          
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

          
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

          
"bundle-name": "string" Bundle name

        },
        
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

        
"interface-name": "string", The name of interface
        : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

          
"access-list-name": "string" Access-list to account for

        },
        : {
BFD configurationPUTPOSTDELETEGET
          
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

          
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

        },
        
"neighbor-filter": "string", Access-list of neighbors to be filtered

        
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

        
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

        
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

        
"interface-enable": "boolean", Enable PIM processing on the interface

        
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

        
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

        
"bsr-border": "boolean" BSR Border configuration for Interface

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/interfaces/

Create operation of resource: interfaces

interfaces_schema

interfacesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Interface-level ConfigurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only
          
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

          
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

          
"bundle-name": "string" Bundle name

        },
        
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

        
"interface-name": "string", The name of interface
        : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

          
"access-list-name": "string" Access-list to account for

        },
        : {
BFD configurationPUTPOSTDELETEGET
          
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

          
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

        },
        
"neighbor-filter": "string", Access-list of neighbors to be filtered

        
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

        
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

        
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

        
"interface-enable": "boolean", Enable PIM processing on the interface

        
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

        
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

        
"bsr-border": "boolean" BSR Border configuration for Interface

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/interfaces/

Delete operation of resource: interfaces

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/interfaces/

Retrieve operation of resource: interfaces

vrf-name: string
in path

ID of vrf-name

200 OK
interfaces_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Interface-level ConfigurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only
          
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

          
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

          
"bundle-name": "string" Bundle name

        },
        
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

        
"interface-name": "string", The name of interface
        : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

          
"access-list-name": "string" Access-list to account for

        },
        : {
BFD configurationPUTPOSTDELETEGET
          
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

          
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

        },
        
"neighbor-filter": "string", Access-list of neighbors to be filtered

        
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

        
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

        
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

        
"interface-enable": "boolean", Enable PIM processing on the interface

        
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

        
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

        
"bsr-border": "boolean" BSR Border configuration for Interface

      }
    ]
  }
}

INTERFACE - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/interfaces/interface/{interface-name}/

Update operation of resource: interface

interface_schema

interfacebody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only
        
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

        
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

        
"bundle-name": "string" Bundle name

      },
      
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

      
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

      
"interface-name": "string", The name of interface
      : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

        
"access-list-name": "string" Access-list to account for

      },
      : {
BFD configurationPUTPOSTDELETEGET
        
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

        
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

      },
      
"neighbor-filter": "string", Access-list of neighbors to be filtered

      
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

      
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

      
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

      
"interface-enable": "boolean", Enable PIM processing on the interface

      
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

      
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

      
"bsr-border": "boolean" BSR Border configuration for Interface

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/interfaces/interface/{interface-name}/

Create operation of resource: interface

interface_schema

interfacebody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only
        
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

        
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

        
"bundle-name": "string" Bundle name

      },
      
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

      
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

      
"interface-name": "string", The name of interface
      : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

        
"access-list-name": "string" Access-list to account for

      },
      : {
BFD configurationPUTPOSTDELETEGET
        
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

        
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

      },
      
"neighbor-filter": "string", Access-list of neighbors to be filtered

      
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

      
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

      
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

      
"interface-enable": "boolean", Enable PIM processing on the interface

      
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

      
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

      
"bsr-border": "boolean" BSR Border configuration for Interface

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/interfaces/interface/{interface-name}/

Delete operation of resource: interface

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/interfaces/interface/{interface-name}/

Retrieve operation of resource: interface

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK
interface_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only
        
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

        
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

        
"bundle-name": "string" Bundle name

      },
      
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

      
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

      
"interface-name": "string", The name of interface
      : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

        
"access-list-name": "string" Access-list to account for

      },
      : {
BFD configurationPUTPOSTDELETEGET
        
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

        
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

      },
      
"neighbor-filter": "string", Access-list of neighbors to be filtered

      
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

      
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

      
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

      
"interface-enable": "boolean", Enable PIM processing on the interface

      
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

      
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

      
"bsr-border": "boolean" BSR Border configuration for Interface

    }
  ]
}

MAXIMUM-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/interfaces/interface/{interface-name}/maximum-routes/

Update operation of resource: maximum-routes

maximum-routes_schema

maximum-routesbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

    
"access-list-name": "string" Access-list to account for

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-ROUTES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/interfaces/interface/{interface-name}/maximum-routes/

Create operation of resource: maximum-routes

maximum-routes_schema

maximum-routesbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

    
"access-list-name": "string" Access-list to account for

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/interfaces/interface/{interface-name}/maximum-routes/

Delete operation of resource: maximum-routes

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/interfaces/interface/{interface-name}/maximum-routes/

Retrieve operation of resource: maximum-routes

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK
maximum-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

    
"access-list-name": "string" Access-list to account for

  }
}

BFD - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/interfaces/interface/{interface-name}/bfd/

Update operation of resource: bfd

bfd_schema

bfdbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
BFD configurationPUTPOSTDELETEGET
    
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

    
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

    
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BFD - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/interfaces/interface/{interface-name}/bfd/

Create operation of resource: bfd

bfd_schema

bfdbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
BFD configurationPUTPOSTDELETEGET
    
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

    
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

    
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BFD - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/interfaces/interface/{interface-name}/bfd/

Delete operation of resource: bfd

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BFD - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/vrfs/vrf/{vrf-name}/ipv6/interfaces/interface/{interface-name}/bfd/

Retrieve operation of resource: bfd

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK
bfd_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
BFD configurationPUTPOSTDELETEGET
    
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

    
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

    
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

  }
}

DEFAULT-CONTEXT - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/

Update operation of resource: default-context

default-context_schema

default-contextbody object

Request Content-Types: application/json
Request Example
{
  : {
Default ContextPUTPOSTDELETEGET
    : {
IPV4 commandsPUTPOSTDELETEGET
      : {
Configure Candidate-RPsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"protocol-mode": "string", Protocol Mode

            
"ttl": "string", TTL in Hops

            
"access-list-name": "string", Access list of groups that should map to a\ngiven RP

            
"announce-period": "string", Time between discovery messages 

            
"interface-name": "string" The name of interface

          }
        ]
      },
      : {
Configure Non-stop forwarding (NSF) optionsPUTPOSTDELETEGET
        
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

      },
      : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"rpf-proxy-address": "string", RPF Proxy Address

            
"prefix-length": "string", Hash Mask Length for this candidate BSR

            
"source-address": "string" Source Address

          }
        ]
      },
      : [
Configure convergence parametersPUTPOSTDELETEGET
        {
          
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

          
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

        }
      ],
      
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
      : {
Configure RPF optionsPUTPOSTDELETEGET
        
"route-policy": "string" Route policy to select RPF topology

      },
      
"multipath": "string", Enable equal-cost multipath routing

      
"register-source": "string", Source address to use for register messages

      
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
      : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"rpf-proxy-address": "string", RPF Proxy Address

            
"prefix-length": "string", Hash Mask Length for this candidate BSR

            
"source-address": "string" Source Address

          }
        ]
      },
      
"neighbor-filter": "string", Access-list of neighbors to be filtered
      : [
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
        {
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        }
      ],
      : {
Configure AutoRP Mapping AgentPUTPOSTDELETEGET
        : {
Specifications for Mapping Agent configured\non this boxPUTPOSTDELETEGET
          
"interface-name": "string", The name of interface

          
"announce-period": "string", Time between discovery messages 

          
"ttl": "string" TTL in Hops

        },
        : {
Mapping Agent cache size limitPUTPOSTDELETEGET
          
"maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"

          
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"

        }
      },
      : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
        
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      },
      
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
      : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
        
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

        
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

      },
      : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
        
"rp-list-name": "string", Access-list specifiying applicable RPs

        
"group-list-name": "string" Access-list specifiying applicable groups

      },
      
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol

      
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
      : {
Configure RPF-redirect featurePUTPOSTDELETEGET
        
"route-policy": "string" Route policy to select RPF topology

      },
      
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
      : {
Interface-level ConfigurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 onlyPUTPOSTDELETEGET
              
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

              
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

              
"bundle-name": "string" Bundle name

            },
            
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

            
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

            
"interface-name": "string", The name of interface
            : {
Maximum number of PIM routesPUTPOSTDELETEGET
              
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

              
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            },
            : {
BFD configurationPUTPOSTDELETEGET
              
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

              
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

            },
            
"neighbor-filter": "string", Access-list of neighbors to be filtered

            
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

            
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

            
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

            
"interface-enable": "boolean", Enable PIM processing on the interface

            
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

            
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

            
"bsr-border": "boolean" BSR Border configuration for Interface

          }
        ]
      },
      : {
PIM BSR configurationPUTPOSTDELETEGET
        : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
          
"priority": "string", Priority of the CRP

          
"prefix-length": "string", Hash Mask Length for this candidate BSR

          
"address": "string" Address of Candidate-RP

        },
        : {
PIM RP configurationPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

              
"priority": "string", Priority of the CRP

              
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

              
"mode": "string", SM or Bidir

              
"address": "string" Address of Candidate-RP

            }
          ]
        }
      },
      : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
        
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

        
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
        : {
Clone multicast joinsPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"source": "string", Original source address (S)

              
"prefix-length": "string", Hash Mask Length for this candidate BSR

              
"backup": "string", Backup cloned address (S2)

              
"primary": "string" Primary cloned address (S1)

            }
          ]
        },
        : {
Clone multicast trafficPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"source": "string", Original source address (S)

              
"prefix-length": "string", Hash Mask Length for this candidate BSR

              
"backup": "string", Backup cloned address (S2)

              
"primary": "string" Primary cloned address (S1)

            }
          ]
        },
        
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

      },
      : {
Configure IP Multicast SSMPUTPOSTDELETEGET
        
"range": "string", Access list of groups enabled with SSM

        
"disable": "boolean" TRUE if SSM is disabled on this router

      },
      
"rp-static-deny": "string", Configure static RP deny range

      
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
      : {
Inheritable defaultsPUTPOSTDELETEGET
        
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

        
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

        
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

        
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

        
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

        
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

        
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

      },
      : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

            
"rp-address": "string", RP address of Rendezvous Point

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          }
        ]
      },
      
"accept-register": "string", Access-list which specifies unauthorized sources

      
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
      : {
Configure PIM State LimitsPUTPOSTDELETEGET
        
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
        : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
          
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

          
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

        },
        : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
          
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

          
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

        },
        : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
          
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

        },
        : {
Override default maximum for number of routesPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

        },
        : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
          
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
          
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

        },
        
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
        : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
          
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default maximum for number of routesPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

        },
        : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
          
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

        }
      },
      
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

    },
    : {
IPV6 commandsPUTPOSTDELETEGET
      : {
Configure Non-stop forwarding (NSF) optionsPUTPOSTDELETEGET
        
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

      },
      : {
Configure convergence parametersPUTPOSTDELETEGET
        
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

        
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

      },
      
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
      : {
Configure RPF optionsPUTPOSTDELETEGET
        
"route-policy": "string" Route policy to select RPF topology

      },
      
"multipath": "string", Enable equal-cost multipath routing

      
"register-source": "string", Source address to use for register messages

      
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages

      
"neighbor-filter": "string", Access-list of neighbors to be filtered
      : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

            
"rp-address": "string", RP address of Rendezvous Point

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          }
        ]
      },
      
"accept-register": "string", Access-list which specifies unauthorized sources
      : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
        
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      },
      
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
      : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
        
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

        
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

      },
      : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
        
"rp-list-name": "string", Access-list specifiying applicable RPs

        
"group-list-name": "string" Access-list specifiying applicable groups

      },
      
"embedded-rp-disable": "null", Set Embedded RP processing support

      
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

      
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
      : {
Interface-level ConfigurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"neighbor-filter": "string", Access-list of neighbors to be filtered

            
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

            
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

            
"interface-name": "string", The name of interface
            : {
Maximum number of PIM routesPUTPOSTDELETEGET
              
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

              
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            },
            : {
BFD configurationPUTPOSTDELETEGET
              
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

              
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

            },
            
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

            
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

            
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

            
"interface-enable": "boolean", Enable PIM processing on the interface

            
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

            
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

            
"bsr-border": "boolean" BSR Border configuration for Interface

          }
        ]
      },
      : {
Set Embedded RP processing supportPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"rp-address": "string", RP address of Rendezvous Point

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          }
        ]
      },
      : {
PIM BSR configurationPUTPOSTDELETEGET
        : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
          
"priority": "string", Priority of the CRP

          
"prefix-length": "string", Hash Mask Length for this candidate BSR

          
"address": "string" Address of Candidate-RP

        },
        : {
PIM RP configurationPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

              
"priority": "string", Priority of the CRP

              
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

              
"mode": "string", SM or Bidir

              
"address": "string" Address of Candidate-RP

            }
          ]
        }
      },
      : {
Configure IP Multicast SSMPUTPOSTDELETEGET
        
"range": "string", Access list of groups enabled with SSM

        
"disable": "boolean" TRUE if SSM is disabled on this router

      },
      
"rp-static-deny": "string", Configure static RP deny range

      
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
      : {
Inheritable defaultsPUTPOSTDELETEGET
        
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

        
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

        
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

        
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

        
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

        
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

        
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

      },
      : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

            
"rp-address": "string", RP address of Rendezvous Point

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          }
        ]
      },
      
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
      : {
Configure PIM State LimitsPUTPOSTDELETEGET
        
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
        : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
          
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

          
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

        },
        : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
          
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

          
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

        },
        : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
          
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

        },
        : {
Override default maximum for number of routesPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

        },
        : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
          
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
          
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

        },
        
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
        : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
          
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default maximum for number of routesPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

        },
        : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
          
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

        }
      },
      
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-CONTEXT - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/

Create operation of resource: default-context

default-context_schema

default-contextbody object

Request Content-Types: application/json
Request Example
{
  : {
Default ContextPUTPOSTDELETEGET
    : {
IPV4 commandsPUTPOSTDELETEGET
      : {
Configure Candidate-RPsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"protocol-mode": "string", Protocol Mode

            
"ttl": "string", TTL in Hops

            
"access-list-name": "string", Access list of groups that should map to a\ngiven RP

            
"announce-period": "string", Time between discovery messages 

            
"interface-name": "string" The name of interface

          }
        ]
      },
      : {
Configure Non-stop forwarding (NSF) optionsPUTPOSTDELETEGET
        
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

      },
      : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"rpf-proxy-address": "string", RPF Proxy Address

            
"prefix-length": "string", Hash Mask Length for this candidate BSR

            
"source-address": "string" Source Address

          }
        ]
      },
      : [
Configure convergence parametersPUTPOSTDELETEGET
        {
          
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

          
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

        }
      ],
      
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
      : {
Configure RPF optionsPUTPOSTDELETEGET
        
"route-policy": "string" Route policy to select RPF topology

      },
      
"multipath": "string", Enable equal-cost multipath routing

      
"register-source": "string", Source address to use for register messages

      
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
      : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"rpf-proxy-address": "string", RPF Proxy Address

            
"prefix-length": "string", Hash Mask Length for this candidate BSR

            
"source-address": "string" Source Address

          }
        ]
      },
      
"neighbor-filter": "string", Access-list of neighbors to be filtered
      : [
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
        {
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        }
      ],
      : {
Configure AutoRP Mapping AgentPUTPOSTDELETEGET
        : {
Specifications for Mapping Agent configured\non this boxPUTPOSTDELETEGET
          
"interface-name": "string", The name of interface

          
"announce-period": "string", Time between discovery messages 

          
"ttl": "string" TTL in Hops

        },
        : {
Mapping Agent cache size limitPUTPOSTDELETEGET
          
"maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"

          
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"

        }
      },
      : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
        
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      },
      
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
      : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
        
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

        
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

      },
      : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
        
"rp-list-name": "string", Access-list specifiying applicable RPs

        
"group-list-name": "string" Access-list specifiying applicable groups

      },
      
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol

      
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
      : {
Configure RPF-redirect featurePUTPOSTDELETEGET
        
"route-policy": "string" Route policy to select RPF topology

      },
      
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
      : {
Interface-level ConfigurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 onlyPUTPOSTDELETEGET
              
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

              
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

              
"bundle-name": "string" Bundle name

            },
            
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

            
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

            
"interface-name": "string", The name of interface
            : {
Maximum number of PIM routesPUTPOSTDELETEGET
              
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

              
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            },
            : {
BFD configurationPUTPOSTDELETEGET
              
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

              
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

            },
            
"neighbor-filter": "string", Access-list of neighbors to be filtered

            
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

            
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

            
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

            
"interface-enable": "boolean", Enable PIM processing on the interface

            
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

            
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

            
"bsr-border": "boolean" BSR Border configuration for Interface

          }
        ]
      },
      : {
PIM BSR configurationPUTPOSTDELETEGET
        : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
          
"priority": "string", Priority of the CRP

          
"prefix-length": "string", Hash Mask Length for this candidate BSR

          
"address": "string" Address of Candidate-RP

        },
        : {
PIM RP configurationPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

              
"priority": "string", Priority of the CRP

              
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

              
"mode": "string", SM or Bidir

              
"address": "string" Address of Candidate-RP

            }
          ]
        }
      },
      : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
        
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

        
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
        : {
Clone multicast joinsPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"source": "string", Original source address (S)

              
"prefix-length": "string", Hash Mask Length for this candidate BSR

              
"backup": "string", Backup cloned address (S2)

              
"primary": "string" Primary cloned address (S1)

            }
          ]
        },
        : {
Clone multicast trafficPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"source": "string", Original source address (S)

              
"prefix-length": "string", Hash Mask Length for this candidate BSR

              
"backup": "string", Backup cloned address (S2)

              
"primary": "string" Primary cloned address (S1)

            }
          ]
        },
        
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

      },
      : {
Configure IP Multicast SSMPUTPOSTDELETEGET
        
"range": "string", Access list of groups enabled with SSM

        
"disable": "boolean" TRUE if SSM is disabled on this router

      },
      
"rp-static-deny": "string", Configure static RP deny range

      
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
      : {
Inheritable defaultsPUTPOSTDELETEGET
        
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

        
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

        
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

        
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

        
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

        
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

        
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

      },
      : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

            
"rp-address": "string", RP address of Rendezvous Point

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          }
        ]
      },
      
"accept-register": "string", Access-list which specifies unauthorized sources

      
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
      : {
Configure PIM State LimitsPUTPOSTDELETEGET
        
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
        : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
          
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

          
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

        },
        : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
          
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

          
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

        },
        : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
          
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

        },
        : {
Override default maximum for number of routesPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

        },
        : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
          
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
          
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

        },
        
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
        : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
          
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default maximum for number of routesPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

        },
        : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
          
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

        }
      },
      
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

    },
    : {
IPV6 commandsPUTPOSTDELETEGET
      : {
Configure Non-stop forwarding (NSF) optionsPUTPOSTDELETEGET
        
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

      },
      : {
Configure convergence parametersPUTPOSTDELETEGET
        
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

        
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

      },
      
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
      : {
Configure RPF optionsPUTPOSTDELETEGET
        
"route-policy": "string" Route policy to select RPF topology

      },
      
"multipath": "string", Enable equal-cost multipath routing

      
"register-source": "string", Source address to use for register messages

      
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages

      
"neighbor-filter": "string", Access-list of neighbors to be filtered
      : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

            
"rp-address": "string", RP address of Rendezvous Point

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          }
        ]
      },
      
"accept-register": "string", Access-list which specifies unauthorized sources
      : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
        
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      },
      
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
      : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
        
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

        
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

      },
      : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
        
"rp-list-name": "string", Access-list specifiying applicable RPs

        
"group-list-name": "string" Access-list specifiying applicable groups

      },
      
"embedded-rp-disable": "null", Set Embedded RP processing support

      
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

      
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
      : {
Interface-level ConfigurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"neighbor-filter": "string", Access-list of neighbors to be filtered

            
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

            
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

            
"interface-name": "string", The name of interface
            : {
Maximum number of PIM routesPUTPOSTDELETEGET
              
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

              
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            },
            : {
BFD configurationPUTPOSTDELETEGET
              
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

              
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

            },
            
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

            
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

            
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

            
"interface-enable": "boolean", Enable PIM processing on the interface

            
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

            
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

            
"bsr-border": "boolean" BSR Border configuration for Interface

          }
        ]
      },
      : {
Set Embedded RP processing supportPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"rp-address": "string", RP address of Rendezvous Point

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          }
        ]
      },
      : {
PIM BSR configurationPUTPOSTDELETEGET
        : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
          
"priority": "string", Priority of the CRP

          
"prefix-length": "string", Hash Mask Length for this candidate BSR

          
"address": "string" Address of Candidate-RP

        },
        : {
PIM RP configurationPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

              
"priority": "string", Priority of the CRP

              
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

              
"mode": "string", SM or Bidir

              
"address": "string" Address of Candidate-RP

            }
          ]
        }
      },
      : {
Configure IP Multicast SSMPUTPOSTDELETEGET
        
"range": "string", Access list of groups enabled with SSM

        
"disable": "boolean" TRUE if SSM is disabled on this router

      },
      
"rp-static-deny": "string", Configure static RP deny range

      
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
      : {
Inheritable defaultsPUTPOSTDELETEGET
        
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

        
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

        
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

        
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

        
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

        
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

        
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

      },
      : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

            
"rp-address": "string", RP address of Rendezvous Point

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          }
        ]
      },
      
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
      : {
Configure PIM State LimitsPUTPOSTDELETEGET
        
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
        : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
          
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

          
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

        },
        : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
          
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

          
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

        },
        : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
          
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

        },
        : {
Override default maximum for number of routesPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

        },
        : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
          
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
          
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

        },
        
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
        : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
          
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default maximum for number of routesPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

        },
        : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
          
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

        }
      },
      
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-CONTEXT - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/

Delete operation of resource: default-context

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-CONTEXT - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/

Retrieve operation of resource: default-context

200 OK
default-context_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Default ContextPUTPOSTDELETEGET
    : {
IPV4 commandsPUTPOSTDELETEGET
      : {
Configure Candidate-RPsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"protocol-mode": "string", Protocol Mode

            
"ttl": "string", TTL in Hops

            
"access-list-name": "string", Access list of groups that should map to a\ngiven RP

            
"announce-period": "string", Time between discovery messages 

            
"interface-name": "string" The name of interface

          }
        ]
      },
      : {
Configure Non-stop forwarding (NSF) optionsPUTPOSTDELETEGET
        
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

      },
      : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"rpf-proxy-address": "string", RPF Proxy Address

            
"prefix-length": "string", Hash Mask Length for this candidate BSR

            
"source-address": "string" Source Address

          }
        ]
      },
      : [
Configure convergence parametersPUTPOSTDELETEGET
        {
          
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

          
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

        }
      ],
      
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
      : {
Configure RPF optionsPUTPOSTDELETEGET
        
"route-policy": "string" Route policy to select RPF topology

      },
      
"multipath": "string", Enable equal-cost multipath routing

      
"register-source": "string", Source address to use for register messages

      
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
      : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"rpf-proxy-address": "string", RPF Proxy Address

            
"prefix-length": "string", Hash Mask Length for this candidate BSR

            
"source-address": "string" Source Address

          }
        ]
      },
      
"neighbor-filter": "string", Access-list of neighbors to be filtered
      : [
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
        {
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

              
"rp-address": "string", RP address of Rendezvous Point

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            }
          ]
        }
      ],
      : {
Configure AutoRP Mapping AgentPUTPOSTDELETEGET
        : {
Specifications for Mapping Agent configured\non this boxPUTPOSTDELETEGET
          
"interface-name": "string", The name of interface

          
"announce-period": "string", Time between discovery messages 

          
"ttl": "string" TTL in Hops

        },
        : {
Mapping Agent cache size limitPUTPOSTDELETEGET
          
"maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"

          
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"

        }
      },
      : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
        
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      },
      
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
      : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
        
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

        
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

      },
      : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
        
"rp-list-name": "string", Access-list specifiying applicable RPs

        
"group-list-name": "string" Access-list specifiying applicable groups

      },
      
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol

      
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
      : {
Configure RPF-redirect featurePUTPOSTDELETEGET
        
"route-policy": "string" Route policy to select RPF topology

      },
      
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
      : {
Interface-level ConfigurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 onlyPUTPOSTDELETEGET
              
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

              
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

              
"bundle-name": "string" Bundle name

            },
            
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

            
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

            
"interface-name": "string", The name of interface
            : {
Maximum number of PIM routesPUTPOSTDELETEGET
              
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

              
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            },
            : {
BFD configurationPUTPOSTDELETEGET
              
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

              
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

            },
            
"neighbor-filter": "string", Access-list of neighbors to be filtered

            
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

            
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

            
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

            
"interface-enable": "boolean", Enable PIM processing on the interface

            
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

            
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

            
"bsr-border": "boolean" BSR Border configuration for Interface

          }
        ]
      },
      : {
PIM BSR configurationPUTPOSTDELETEGET
        : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
          
"priority": "string", Priority of the CRP

          
"prefix-length": "string", Hash Mask Length for this candidate BSR

          
"address": "string" Address of Candidate-RP

        },
        : {
PIM RP configurationPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

              
"priority": "string", Priority of the CRP

              
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

              
"mode": "string", SM or Bidir

              
"address": "string" Address of Candidate-RP

            }
          ]
        }
      },
      : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
        
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

        
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
        : {
Clone multicast joinsPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"source": "string", Original source address (S)

              
"prefix-length": "string", Hash Mask Length for this candidate BSR

              
"backup": "string", Backup cloned address (S2)

              
"primary": "string" Primary cloned address (S1)

            }
          ]
        },
        : {
Clone multicast trafficPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"source": "string", Original source address (S)

              
"prefix-length": "string", Hash Mask Length for this candidate BSR

              
"backup": "string", Backup cloned address (S2)

              
"primary": "string" Primary cloned address (S1)

            }
          ]
        },
        
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

      },
      : {
Configure IP Multicast SSMPUTPOSTDELETEGET
        
"range": "string", Access list of groups enabled with SSM

        
"disable": "boolean" TRUE if SSM is disabled on this router

      },
      
"rp-static-deny": "string", Configure static RP deny range

      
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
      : {
Inheritable defaultsPUTPOSTDELETEGET
        
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

        
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

        
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

        
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

        
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

        
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

        
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

      },
      : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

            
"rp-address": "string", RP address of Rendezvous Point

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          }
        ]
      },
      
"accept-register": "string", Access-list which specifies unauthorized sources

      
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
      : {
Configure PIM State LimitsPUTPOSTDELETEGET
        
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
        : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
          
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

          
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

        },
        : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
          
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

          
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

        },
        : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
          
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

        },
        : {
Override default maximum for number of routesPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

        },
        : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
          
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
          
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

        },
        
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
        : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
          
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default maximum for number of routesPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

        },
        : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
          
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

        }
      },
      
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

    },
    : {
IPV6 commandsPUTPOSTDELETEGET
      : {
Configure Non-stop forwarding (NSF) optionsPUTPOSTDELETEGET
        
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

      },
      : {
Configure convergence parametersPUTPOSTDELETEGET
        
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

        
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

      },
      
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
      : {
Configure RPF optionsPUTPOSTDELETEGET
        
"route-policy": "string" Route policy to select RPF topology

      },
      
"multipath": "string", Enable equal-cost multipath routing

      
"register-source": "string", Source address to use for register messages

      
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages

      
"neighbor-filter": "string", Access-list of neighbors to be filtered
      : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

            
"rp-address": "string", RP address of Rendezvous Point

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          }
        ]
      },
      
"accept-register": "string", Access-list which specifies unauthorized sources
      : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
        
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      },
      
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
      : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
        
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

        
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

      },
      : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
        
"rp-list-name": "string", Access-list specifiying applicable RPs

        
"group-list-name": "string" Access-list specifiying applicable groups

      },
      
"embedded-rp-disable": "null", Set Embedded RP processing support

      
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

      
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
      : {
Interface-level ConfigurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"neighbor-filter": "string", Access-list of neighbors to be filtered

            
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

            
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

            
"interface-name": "string", The name of interface
            : {
Maximum number of PIM routesPUTPOSTDELETEGET
              
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

              
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

              
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

            },
            : {
BFD configurationPUTPOSTDELETEGET
              
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

              
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

              
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

            },
            
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

            
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

            
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

            
"interface-enable": "boolean", Enable PIM processing on the interface

            
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

            
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

            
"bsr-border": "boolean" BSR Border configuration for Interface

          }
        ]
      },
      : {
Set Embedded RP processing supportPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"rp-address": "string", RP address of Rendezvous Point

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          }
        ]
      },
      : {
PIM BSR configurationPUTPOSTDELETEGET
        : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
          
"priority": "string", Priority of the CRP

          
"prefix-length": "string", Hash Mask Length for this candidate BSR

          
"address": "string" Address of Candidate-RP

        },
        : {
PIM RP configurationPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

              
"priority": "string", Priority of the CRP

              
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

              
"mode": "string", SM or Bidir

              
"address": "string" Address of Candidate-RP

            }
          ]
        }
      },
      : {
Configure IP Multicast SSMPUTPOSTDELETEGET
        
"range": "string", Access list of groups enabled with SSM

        
"disable": "boolean" TRUE if SSM is disabled on this router

      },
      
"rp-static-deny": "string", Configure static RP deny range

      
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
      : {
Inheritable defaultsPUTPOSTDELETEGET
        
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

        
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

        
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

        
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

        
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

        
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

        
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

      },
      : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

            
"rp-address": "string", RP address of Rendezvous Point

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          }
        ]
      },
      
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
      : {
Configure PIM State LimitsPUTPOSTDELETEGET
        
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
        : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
          
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

          
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

        },
        : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
          
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

          
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

        },
        : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
          
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

        },
        : {
Override default maximum for number of routesPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

        },
        : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
          
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
          
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

        },
        
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
        : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
          
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default maximum for number of routesPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

        },
        : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
          
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

          
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

        },
        : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

        }
      },
      
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

    }
  }
}

IPV6 - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/

Update operation of resource: ipv6

ipv6_schema

ipv6body object

Request Content-Types: application/json
Request Example
{
  : {
IPV6 commandsPUTPOSTDELETEGET
    : {
Configure Non-stop forwarding (NSF) optionsPUTPOSTDELETEGET
      
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

    },
    : {
Configure convergence parametersPUTPOSTDELETEGET
      
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

      
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

    },
    
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
    : {
Configure RPF optionsPUTPOSTDELETEGET
      
"route-policy": "string" Route policy to select RPF topology

    },
    
"multipath": "string", Enable equal-cost multipath routing

    
"register-source": "string", Source address to use for register messages

    
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages

    
"neighbor-filter": "string", Access-list of neighbors to be filtered
    : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

          
"rp-address": "string", RP address of Rendezvous Point

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        }
      ]
    },
    
"accept-register": "string", Access-list which specifies unauthorized sources
    : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
      
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    },
    
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
    : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
      
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

      
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

      
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

    },
    : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
      
"rp-list-name": "string", Access-list specifiying applicable RPs

      
"group-list-name": "string" Access-list specifiying applicable groups

    },
    
"embedded-rp-disable": "null", Set Embedded RP processing support

    
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

    
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
    : {
Interface-level ConfigurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"neighbor-filter": "string", Access-list of neighbors to be filtered

          
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

          
"interface-name": "string", The name of interface
          : {
Maximum number of PIM routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          },
          : {
BFD configurationPUTPOSTDELETEGET
            
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

            
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

            
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

          },
          
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

          
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

          
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

          
"interface-enable": "boolean", Enable PIM processing on the interface

          
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

          
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

          
"bsr-border": "boolean" BSR Border configuration for Interface

        }
      ]
    },
    : {
Set Embedded RP processing supportPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"rp-address": "string", RP address of Rendezvous Point

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        }
      ]
    },
    : {
PIM BSR configurationPUTPOSTDELETEGET
      : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
        
"priority": "string", Priority of the CRP

        
"prefix-length": "string", Hash Mask Length for this candidate BSR

        
"address": "string" Address of Candidate-RP

      },
      : {
PIM RP configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

            
"priority": "string", Priority of the CRP

            
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

            
"mode": "string", SM or Bidir

            
"address": "string" Address of Candidate-RP

          }
        ]
      }
    },
    : {
Configure IP Multicast SSMPUTPOSTDELETEGET
      
"range": "string", Access list of groups enabled with SSM

      
"disable": "boolean" TRUE if SSM is disabled on this router

    },
    
"rp-static-deny": "string", Configure static RP deny range

    
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
    : {
Inheritable defaultsPUTPOSTDELETEGET
      
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

      
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

      
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

      
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

      
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

      
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

      
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

    },
    : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

          
"rp-address": "string", RP address of Rendezvous Point

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        }
      ]
    },
    
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
    : {
Configure PIM State LimitsPUTPOSTDELETEGET
      
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
      : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
        
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

        
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

      },
      : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
        
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

        
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

      },
      : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
        
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

      },
      : {
Override default maximum for number of routesPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

      },
      : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
        
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
        
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

      },
      
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
      : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
        
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum for number of routesPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

      },
      : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
        
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

      }
    },
    
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/

Create operation of resource: ipv6

ipv6_schema

ipv6body object

Request Content-Types: application/json
Request Example
{
  : {
IPV6 commandsPUTPOSTDELETEGET
    : {
Configure Non-stop forwarding (NSF) optionsPUTPOSTDELETEGET
      
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

    },
    : {
Configure convergence parametersPUTPOSTDELETEGET
      
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

      
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

    },
    
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
    : {
Configure RPF optionsPUTPOSTDELETEGET
      
"route-policy": "string" Route policy to select RPF topology

    },
    
"multipath": "string", Enable equal-cost multipath routing

    
"register-source": "string", Source address to use for register messages

    
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages

    
"neighbor-filter": "string", Access-list of neighbors to be filtered
    : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

          
"rp-address": "string", RP address of Rendezvous Point

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        }
      ]
    },
    
"accept-register": "string", Access-list which specifies unauthorized sources
    : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
      
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    },
    
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
    : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
      
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

      
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

      
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

    },
    : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
      
"rp-list-name": "string", Access-list specifiying applicable RPs

      
"group-list-name": "string" Access-list specifiying applicable groups

    },
    
"embedded-rp-disable": "null", Set Embedded RP processing support

    
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

    
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
    : {
Interface-level ConfigurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"neighbor-filter": "string", Access-list of neighbors to be filtered

          
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

          
"interface-name": "string", The name of interface
          : {
Maximum number of PIM routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          },
          : {
BFD configurationPUTPOSTDELETEGET
            
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

            
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

            
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

          },
          
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

          
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

          
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

          
"interface-enable": "boolean", Enable PIM processing on the interface

          
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

          
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

          
"bsr-border": "boolean" BSR Border configuration for Interface

        }
      ]
    },
    : {
Set Embedded RP processing supportPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"rp-address": "string", RP address of Rendezvous Point

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        }
      ]
    },
    : {
PIM BSR configurationPUTPOSTDELETEGET
      : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
        
"priority": "string", Priority of the CRP

        
"prefix-length": "string", Hash Mask Length for this candidate BSR

        
"address": "string" Address of Candidate-RP

      },
      : {
PIM RP configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

            
"priority": "string", Priority of the CRP

            
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

            
"mode": "string", SM or Bidir

            
"address": "string" Address of Candidate-RP

          }
        ]
      }
    },
    : {
Configure IP Multicast SSMPUTPOSTDELETEGET
      
"range": "string", Access list of groups enabled with SSM

      
"disable": "boolean" TRUE if SSM is disabled on this router

    },
    
"rp-static-deny": "string", Configure static RP deny range

    
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
    : {
Inheritable defaultsPUTPOSTDELETEGET
      
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

      
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

      
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

      
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

      
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

      
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

      
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

    },
    : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

          
"rp-address": "string", RP address of Rendezvous Point

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        }
      ]
    },
    
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
    : {
Configure PIM State LimitsPUTPOSTDELETEGET
      
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
      : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
        
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

        
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

      },
      : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
        
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

        
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

      },
      : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
        
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

      },
      : {
Override default maximum for number of routesPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

      },
      : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
        
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
        
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

      },
      
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
      : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
        
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum for number of routesPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

      },
      : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
        
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

      }
    },
    
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/

Delete operation of resource: ipv6

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/

Retrieve operation of resource: ipv6

200 OK
ipv6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IPV6 commandsPUTPOSTDELETEGET
    : {
Configure Non-stop forwarding (NSF) optionsPUTPOSTDELETEGET
      
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

    },
    : {
Configure convergence parametersPUTPOSTDELETEGET
      
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

      
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

    },
    
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
    : {
Configure RPF optionsPUTPOSTDELETEGET
      
"route-policy": "string" Route policy to select RPF topology

    },
    
"multipath": "string", Enable equal-cost multipath routing

    
"register-source": "string", Source address to use for register messages

    
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages

    
"neighbor-filter": "string", Access-list of neighbors to be filtered
    : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

          
"rp-address": "string", RP address of Rendezvous Point

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        }
      ]
    },
    
"accept-register": "string", Access-list which specifies unauthorized sources
    : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
      
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    },
    
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
    : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
      
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

      
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

      
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

    },
    : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
      
"rp-list-name": "string", Access-list specifiying applicable RPs

      
"group-list-name": "string" Access-list specifiying applicable groups

    },
    
"embedded-rp-disable": "null", Set Embedded RP processing support

    
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes

    
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
    : {
Interface-level ConfigurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"neighbor-filter": "string", Access-list of neighbors to be filtered

          
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

          
"interface-name": "string", The name of interface
          : {
Maximum number of PIM routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          },
          : {
BFD configurationPUTPOSTDELETEGET
            
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

            
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

            
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

          },
          
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

          
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

          
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

          
"interface-enable": "boolean", Enable PIM processing on the interface

          
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

          
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

          
"bsr-border": "boolean" BSR Border configuration for Interface

        }
      ]
    },
    : {
Set Embedded RP processing supportPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"rp-address": "string", RP address of Rendezvous Point

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        }
      ]
    },
    : {
PIM BSR configurationPUTPOSTDELETEGET
      : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
        
"priority": "string", Priority of the CRP

        
"prefix-length": "string", Hash Mask Length for this candidate BSR

        
"address": "string" Address of Candidate-RP

      },
      : {
PIM RP configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

            
"priority": "string", Priority of the CRP

            
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

            
"mode": "string", SM or Bidir

            
"address": "string" Address of Candidate-RP

          }
        ]
      }
    },
    : {
Configure IP Multicast SSMPUTPOSTDELETEGET
      
"range": "string", Access list of groups enabled with SSM

      
"disable": "boolean" TRUE if SSM is disabled on this router

    },
    
"rp-static-deny": "string", Configure static RP deny range

    
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
    : {
Inheritable defaultsPUTPOSTDELETEGET
      
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

      
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

      
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

      
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

      
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

      
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

      
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

    },
    : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

          
"rp-address": "string", RP address of Rendezvous Point

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        }
      ]
    },
    
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
    : {
Configure PIM State LimitsPUTPOSTDELETEGET
      
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
      : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
        
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

        
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

      },
      : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
        
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

        
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

      },
      : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
        
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

      },
      : {
Override default maximum for number of routesPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

      },
      : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
        
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
        
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

      },
      
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
      : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
        
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum for number of routesPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

      },
      : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
        
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

      }
    },
    
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

  }
}

INTERFACES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/interfaces/

Update operation of resource: interfaces

interfaces_schema

interfacesbody object

Request Content-Types: application/json
Request Example
{
  : {
Interface-level ConfigurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only
          
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

          
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

          
"bundle-name": "string" Bundle name

        },
        
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

        
"interface-name": "string", The name of interface
        : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

          
"access-list-name": "string" Access-list to account for

        },
        : {
BFD configurationPUTPOSTDELETEGET
          
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

          
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

        },
        
"neighbor-filter": "string", Access-list of neighbors to be filtered

        
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

        
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

        
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

        
"interface-enable": "boolean", Enable PIM processing on the interface

        
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

        
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

        
"bsr-border": "boolean" BSR Border configuration for Interface

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/interfaces/

Create operation of resource: interfaces

interfaces_schema

interfacesbody object

Request Content-Types: application/json
Request Example
{
  : {
Interface-level ConfigurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only
          
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

          
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

          
"bundle-name": "string" Bundle name

        },
        
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

        
"interface-name": "string", The name of interface
        : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

          
"access-list-name": "string" Access-list to account for

        },
        : {
BFD configurationPUTPOSTDELETEGET
          
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

          
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

        },
        
"neighbor-filter": "string", Access-list of neighbors to be filtered

        
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

        
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

        
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

        
"interface-enable": "boolean", Enable PIM processing on the interface

        
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

        
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

        
"bsr-border": "boolean" BSR Border configuration for Interface

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/interfaces/

Delete operation of resource: interfaces

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/interfaces/

Retrieve operation of resource: interfaces

200 OK
interfaces_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Interface-level ConfigurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only
          
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

          
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

          
"bundle-name": "string" Bundle name

        },
        
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

        
"interface-name": "string", The name of interface
        : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

          
"access-list-name": "string" Access-list to account for

        },
        : {
BFD configurationPUTPOSTDELETEGET
          
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

          
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

        },
        
"neighbor-filter": "string", Access-list of neighbors to be filtered

        
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

        
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

        
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

        
"interface-enable": "boolean", Enable PIM processing on the interface

        
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

        
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

        
"bsr-border": "boolean" BSR Border configuration for Interface

      }
    ]
  }
}

INTERFACE - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/interfaces/interface/{interface-name}/

Update operation of resource: interface

interface_schema

interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only
        
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

        
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

        
"bundle-name": "string" Bundle name

      },
      
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

      
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

      
"interface-name": "string", The name of interface
      : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

        
"access-list-name": "string" Access-list to account for

      },
      : {
BFD configurationPUTPOSTDELETEGET
        
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

        
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

      },
      
"neighbor-filter": "string", Access-list of neighbors to be filtered

      
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

      
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

      
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

      
"interface-enable": "boolean", Enable PIM processing on the interface

      
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

      
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

      
"bsr-border": "boolean" BSR Border configuration for Interface

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/interfaces/interface/{interface-name}/

Create operation of resource: interface

interface_schema

interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only
        
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

        
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

        
"bundle-name": "string" Bundle name

      },
      
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

      
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

      
"interface-name": "string", The name of interface
      : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

        
"access-list-name": "string" Access-list to account for

      },
      : {
BFD configurationPUTPOSTDELETEGET
        
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

        
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

      },
      
"neighbor-filter": "string", Access-list of neighbors to be filtered

      
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

      
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

      
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

      
"interface-enable": "boolean", Enable PIM processing on the interface

      
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

      
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

      
"bsr-border": "boolean" BSR Border configuration for Interface

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/interfaces/interface/{interface-name}/

Delete operation of resource: interface

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/interfaces/interface/{interface-name}/

Retrieve operation of resource: interface

interface-name: string
in path

ID of interface-name

200 OK
interface_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only
        
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

        
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

        
"bundle-name": "string" Bundle name

      },
      
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

      
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

      
"interface-name": "string", The name of interface
      : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

        
"access-list-name": "string" Access-list to account for

      },
      : {
BFD configurationPUTPOSTDELETEGET
        
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

        
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

      },
      
"neighbor-filter": "string", Access-list of neighbors to be filtered

      
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

      
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

      
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

      
"interface-enable": "boolean", Enable PIM processing on the interface

      
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

      
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

      
"bsr-border": "boolean" BSR Border configuration for Interface

    }
  ]
}

MAXIMUM-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/interfaces/interface/{interface-name}/maximum-routes/

Update operation of resource: maximum-routes

maximum-routes_schema

maximum-routesbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

    
"access-list-name": "string" Access-list to account for

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-ROUTES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/interfaces/interface/{interface-name}/maximum-routes/

Create operation of resource: maximum-routes

maximum-routes_schema

maximum-routesbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

    
"access-list-name": "string" Access-list to account for

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/interfaces/interface/{interface-name}/maximum-routes/

Delete operation of resource: maximum-routes

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/interfaces/interface/{interface-name}/maximum-routes/

Retrieve operation of resource: maximum-routes

interface-name: string
in path

ID of interface-name

200 OK
maximum-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

    
"access-list-name": "string" Access-list to account for

  }
}

BFD - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/interfaces/interface/{interface-name}/bfd/

Update operation of resource: bfd

bfd_schema

bfdbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
BFD configurationPUTPOSTDELETEGET
    
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

    
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

    
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BFD - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/interfaces/interface/{interface-name}/bfd/

Create operation of resource: bfd

bfd_schema

bfdbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
BFD configurationPUTPOSTDELETEGET
    
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

    
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

    
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BFD - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/interfaces/interface/{interface-name}/bfd/

Delete operation of resource: bfd

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BFD - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/interfaces/interface/{interface-name}/bfd/

Retrieve operation of resource: bfd

interface-name: string
in path

ID of interface-name

200 OK
bfd_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
BFD configurationPUTPOSTDELETEGET
    
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

    
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

    
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

  }
}

SPARSE-MODE-RP-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/sparse-mode-rp-addresses/

Update operation of resource: sparse-mode-rp-addresses

sparse-mode-rp-addresses_schema

sparse-mode-rp-addressesbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

        
"rp-address": "string", RP address of Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SPARSE-MODE-RP-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/sparse-mode-rp-addresses/

Create operation of resource: sparse-mode-rp-addresses

sparse-mode-rp-addresses_schema

sparse-mode-rp-addressesbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

        
"rp-address": "string", RP address of Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SPARSE-MODE-RP-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/sparse-mode-rp-addresses/

Delete operation of resource: sparse-mode-rp-addresses

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SPARSE-MODE-RP-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/sparse-mode-rp-addresses/

Retrieve operation of resource: sparse-mode-rp-addresses

200 OK
sparse-mode-rp-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

        
"rp-address": "string", RP address of Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}

SPARSE-MODE-RP-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/sparse-mode-rp-addresses/sparse-mode-rp-address/{rp-address}/

Update operation of resource: sparse-mode-rp-address

sparse-mode-rp-address_schema

sparse-mode-rp-addressbody object

rp-address: string
in path

ID of rp-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

      
"rp-address": "string", RP address of Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SPARSE-MODE-RP-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/sparse-mode-rp-addresses/sparse-mode-rp-address/{rp-address}/

Create operation of resource: sparse-mode-rp-address

sparse-mode-rp-address_schema

sparse-mode-rp-addressbody object

rp-address: string
in path

ID of rp-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

      
"rp-address": "string", RP address of Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SPARSE-MODE-RP-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/sparse-mode-rp-addresses/sparse-mode-rp-address/{rp-address}/

Delete operation of resource: sparse-mode-rp-address

rp-address: string
in path

ID of rp-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SPARSE-MODE-RP-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/sparse-mode-rp-addresses/sparse-mode-rp-address/{rp-address}/

Retrieve operation of resource: sparse-mode-rp-address

rp-address: string
in path

ID of rp-address

200 OK
sparse-mode-rp-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

      
"rp-address": "string", RP address of Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}

INHERITABLE-DEFAULTS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/inheritable-defaults/

Update operation of resource: inheritable-defaults

inheritable-defaults_schema

inheritable-defaultsbody object

Request Content-Types: application/json
Request Example
{
  : {
Inheritable defaultsPUTPOSTDELETEGET
    
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

    
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

    
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

    
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

    
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

    
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

    
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERITABLE-DEFAULTS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/inheritable-defaults/

Create operation of resource: inheritable-defaults

inheritable-defaults_schema

inheritable-defaultsbody object

Request Content-Types: application/json
Request Example
{
  : {
Inheritable defaultsPUTPOSTDELETEGET
    
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

    
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

    
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

    
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

    
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

    
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

    
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERITABLE-DEFAULTS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/inheritable-defaults/

Delete operation of resource: inheritable-defaults

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERITABLE-DEFAULTS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/inheritable-defaults/

Retrieve operation of resource: inheritable-defaults

200 OK
inheritable-defaults_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Inheritable defaultsPUTPOSTDELETEGET
    
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

    
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

    
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

    
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

    
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

    
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

    
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

  }
}

RPF - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/rpf/

Update operation of resource: rpf

rpf_schema

rpfbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure RPF optionsPUTPOSTDELETEGET
    
"route-policy": "string" Route policy to select RPF topology

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/rpf/

Create operation of resource: rpf

rpf_schema

rpfbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure RPF optionsPUTPOSTDELETEGET
    
"route-policy": "string" Route policy to select RPF topology

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/rpf/

Delete operation of resource: rpf

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/rpf/

Retrieve operation of resource: rpf

200 OK
rpf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure RPF optionsPUTPOSTDELETEGET
    
"route-policy": "string" Route policy to select RPF topology

  }
}

SG-EXPIRY-TIMER - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/sg-expiry-timer/

Update operation of resource: sg-expiry-timer

sg-expiry-timer_schema

sg-expiry-timerbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
    
"interval": "integer", (S,G) expiry time in seconds
range: "30..600"
units: "second"
default: "60"

    
"access-list-name": "string" Access-list of applicable S,G routes

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SG-EXPIRY-TIMER - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/sg-expiry-timer/

Create operation of resource: sg-expiry-timer

sg-expiry-timer_schema

sg-expiry-timerbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
    
"interval": "integer", (S,G) expiry time in seconds
range: "30..600"
units: "second"
default: "60"

    
"access-list-name": "string" Access-list of applicable S,G routes

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SG-EXPIRY-TIMER - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/sg-expiry-timer/

Delete operation of resource: sg-expiry-timer

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SG-EXPIRY-TIMER - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/sg-expiry-timer/

Retrieve operation of resource: sg-expiry-timer

200 OK
sg-expiry-timer_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
    
"interval": "integer", (S,G) expiry time in seconds
range: "30..600"
units: "second"
default: "60"

    
"access-list-name": "string" Access-list of applicable S,G routes

  }
}

RPF-VECTOR-ENABLE - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/rpf-vector-enable/

Update operation of resource: rpf-vector-enable

rpf-vector-enable_schema

rpf-vector-enablebody object

Request Content-Types: application/json
Request Example
{
  : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
    
"enable": "null", RPF Vector is turned on if configured

    
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

    
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF-VECTOR-ENABLE - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/rpf-vector-enable/

Create operation of resource: rpf-vector-enable

rpf-vector-enable_schema

rpf-vector-enablebody object

Request Content-Types: application/json
Request Example
{
  : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
    
"enable": "null", RPF Vector is turned on if configured

    
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

    
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF-VECTOR-ENABLE - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/rpf-vector-enable/

Delete operation of resource: rpf-vector-enable

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF-VECTOR-ENABLE - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/rpf-vector-enable/

Retrieve operation of resource: rpf-vector-enable

200 OK
rpf-vector-enable_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
    
"enable": "null", RPF Vector is turned on if configured

    
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

    
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

  }
}

NSF - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/nsf/

Update operation of resource: nsf

nsf_schema

nsfbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure Non-stop forwarding (NSF) optionsPUTPOSTDELETEGET
    
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NSF - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/nsf/

Create operation of resource: nsf

nsf_schema

nsfbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure Non-stop forwarding (NSF) optionsPUTPOSTDELETEGET
    
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NSF - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/nsf/

Delete operation of resource: nsf

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NSF - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/nsf/

Retrieve operation of resource: nsf

200 OK
nsf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure Non-stop forwarding (NSF) optionsPUTPOSTDELETEGET
    
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

  }
}

MAXIMUM - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/

Update operation of resource: maximum

maximum_schema

maximumbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure PIM State LimitsPUTPOSTDELETEGET
    
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
    : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
      
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

      
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

    },
    : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
      
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

      
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

    },
    : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
      
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

    },
    : {
Override default maximum for number of routesPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

    },
    : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
      
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
      
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

    },
    
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
    : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
      
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum for number of routesPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

    },
    : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
      
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/

Create operation of resource: maximum

maximum_schema

maximumbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure PIM State LimitsPUTPOSTDELETEGET
    
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
    : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
      
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

      
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

    },
    : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
      
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

      
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

    },
    : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
      
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

    },
    : {
Override default maximum for number of routesPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

    },
    : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
      
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
      
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

    },
    
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
    : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
      
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum for number of routesPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

    },
    : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
      
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/

Delete operation of resource: maximum

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/

Retrieve operation of resource: maximum

200 OK
maximum_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure PIM State LimitsPUTPOSTDELETEGET
    
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
    : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
      
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

      
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

    },
    : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
      
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

      
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

    },
    : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
      
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

    },
    : {
Override default maximum for number of routesPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

    },
    : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
      
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
      
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

    },
    
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
    : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
      
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum for number of routesPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

    },
    : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
      
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

    }
  }
}

BSR-GLOBAL-GROUP-MAPPINGS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/bsr-global-group-mappings/

Update operation of resource: bsr-global-group-mappings

bsr-global-group-mappings_schema

bsr-global-group-mappingsbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-GLOBAL-GROUP-MAPPINGS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/bsr-global-group-mappings/

Create operation of resource: bsr-global-group-mappings

bsr-global-group-mappings_schema

bsr-global-group-mappingsbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-GLOBAL-GROUP-MAPPINGS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/bsr-global-group-mappings/

Delete operation of resource: bsr-global-group-mappings

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-GLOBAL-GROUP-MAPPINGS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/bsr-global-group-mappings/

Retrieve operation of resource: bsr-global-group-mappings

200 OK
bsr-global-group-mappings_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

  }
}

GLOBAL-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/global-routes/

Update operation of resource: global-routes

global-routes_schema

global-routesbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of routesPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-ROUTES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/global-routes/

Create operation of resource: global-routes

global-routes_schema

global-routesbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of routesPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/global-routes/

Delete operation of resource: global-routes

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/global-routes/

Retrieve operation of resource: global-routes

200 OK
global-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum for number of routesPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

  }
}

GLOBAL-GROUP-MAPPINGS-AUTO-RP - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/global-group-mappings-auto-rp/

Update operation of resource: global-group-mappings-auto-rp

global-group-mappings-auto-rp_schema

global-group-mappings-auto-rpbody object

Request Content-Types: application/json
Request Example
{
  : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
    
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

    
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-GROUP-MAPPINGS-AUTO-RP - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/global-group-mappings-auto-rp/

Create operation of resource: global-group-mappings-auto-rp

global-group-mappings-auto-rp_schema

global-group-mappings-auto-rpbody object

Request Content-Types: application/json
Request Example
{
  : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
    
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

    
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-GROUP-MAPPINGS-AUTO-RP - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/global-group-mappings-auto-rp/

Delete operation of resource: global-group-mappings-auto-rp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-GROUP-MAPPINGS-AUTO-RP - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/global-group-mappings-auto-rp/

Retrieve operation of resource: global-group-mappings-auto-rp

200 OK
global-group-mappings-auto-rp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
    
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

    
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

  }
}

BSR-GLOBAL-CANDIDATE-RP-CACHE - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/bsr-global-candidate-rp-cache/

Update operation of resource: bsr-global-candidate-rp-cache

bsr-global-candidate-rp-cache_schema

bsr-global-candidate-rp-cachebody object

Request Content-Types: application/json
Request Example
{
  : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-GLOBAL-CANDIDATE-RP-CACHE - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/bsr-global-candidate-rp-cache/

Create operation of resource: bsr-global-candidate-rp-cache

bsr-global-candidate-rp-cache_schema

bsr-global-candidate-rp-cachebody object

Request Content-Types: application/json
Request Example
{
  : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-GLOBAL-CANDIDATE-RP-CACHE - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/bsr-global-candidate-rp-cache/

Delete operation of resource: bsr-global-candidate-rp-cache

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-GLOBAL-CANDIDATE-RP-CACHE - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/bsr-global-candidate-rp-cache/

Retrieve operation of resource: bsr-global-candidate-rp-cache

200 OK
bsr-global-candidate-rp-cache_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

  }
}

GLOBAL-REGISTER-STATES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/global-register-states/

Update operation of resource: global-register-states

global-register-states_schema

global-register-statesbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
    
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-REGISTER-STATES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/global-register-states/

Create operation of resource: global-register-states

global-register-states_schema

global-register-statesbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
    
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-REGISTER-STATES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/global-register-states/

Delete operation of resource: global-register-states

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-REGISTER-STATES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/global-register-states/

Retrieve operation of resource: global-register-states

200 OK
global-register-states_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
    
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}

GLOBAL-ROUTE-INTERFACES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/global-route-interfaces/

Update operation of resource: global-route-interfaces

global-route-interfaces_schema

global-route-interfacesbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
    
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-ROUTE-INTERFACES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/global-route-interfaces/

Create operation of resource: global-route-interfaces

global-route-interfaces_schema

global-route-interfacesbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
    
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-ROUTE-INTERFACES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/global-route-interfaces/

Delete operation of resource: global-route-interfaces

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-ROUTE-INTERFACES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/global-route-interfaces/

Retrieve operation of resource: global-route-interfaces

200 OK
global-route-interfaces_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
    
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}

GROUP-MAPPINGS-AUTO-RP - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/group-mappings-auto-rp/

Update operation of resource: group-mappings-auto-rp

group-mappings-auto-rp_schema

group-mappings-auto-rpbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
    
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

    
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-MAPPINGS-AUTO-RP - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/group-mappings-auto-rp/

Create operation of resource: group-mappings-auto-rp

group-mappings-auto-rp_schema

group-mappings-auto-rpbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
    
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

    
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-MAPPINGS-AUTO-RP - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/group-mappings-auto-rp/

Delete operation of resource: group-mappings-auto-rp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-MAPPINGS-AUTO-RP - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/group-mappings-auto-rp/

Retrieve operation of resource: group-mappings-auto-rp

200 OK
group-mappings-auto-rp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
    
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

    
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

  }
}

BSR-GROUP-MAPPINGS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/bsr-group-mappings/

Update operation of resource: bsr-group-mappings

bsr-group-mappings_schema

bsr-group-mappingsbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-GROUP-MAPPINGS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/bsr-group-mappings/

Create operation of resource: bsr-group-mappings

bsr-group-mappings_schema

bsr-group-mappingsbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-GROUP-MAPPINGS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/bsr-group-mappings/

Delete operation of resource: bsr-group-mappings

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-GROUP-MAPPINGS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/bsr-group-mappings/

Retrieve operation of resource: bsr-group-mappings

200 OK
bsr-group-mappings_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

  }
}

REGISTER-STATES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/register-states/

Update operation of resource: register-states

register-states_schema

register-statesbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
    
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REGISTER-STATES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/register-states/

Create operation of resource: register-states

register-states_schema

register-statesbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
    
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REGISTER-STATES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/register-states/

Delete operation of resource: register-states

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REGISTER-STATES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/register-states/

Retrieve operation of resource: register-states

200 OK
register-states_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
    
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}

ROUTE-INTERFACES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/route-interfaces/

Update operation of resource: route-interfaces

route-interfaces_schema

route-interfacesbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
    
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTE-INTERFACES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/route-interfaces/

Create operation of resource: route-interfaces

route-interfaces_schema

route-interfacesbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
    
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTE-INTERFACES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/route-interfaces/

Delete operation of resource: route-interfaces

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTE-INTERFACES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/route-interfaces/

Retrieve operation of resource: route-interfaces

200 OK
route-interfaces_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
    
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}

BSR-CANDIDATE-RP-CACHE - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/bsr-candidate-rp-cache/

Update operation of resource: bsr-candidate-rp-cache

bsr-candidate-rp-cache_schema

bsr-candidate-rp-cachebody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
    
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-CANDIDATE-RP-CACHE - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/bsr-candidate-rp-cache/

Create operation of resource: bsr-candidate-rp-cache

bsr-candidate-rp-cache_schema

bsr-candidate-rp-cachebody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
    
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-CANDIDATE-RP-CACHE - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/bsr-candidate-rp-cache/

Delete operation of resource: bsr-candidate-rp-cache

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-CANDIDATE-RP-CACHE - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/bsr-candidate-rp-cache/

Retrieve operation of resource: bsr-candidate-rp-cache

200 OK
bsr-candidate-rp-cache_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
    
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}

ROUTES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/routes/

Update operation of resource: routes

routes_schema

routesbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of routesPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/routes/

Create operation of resource: routes

routes_schema

routesbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of routesPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/routes/

Delete operation of resource: routes

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/maximum/routes/

Retrieve operation of resource: routes

200 OK
routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum for number of routesPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

  }
}

SSM - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/ssm/

Update operation of resource: ssm

ssm_schema

ssmbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IP Multicast SSMPUTPOSTDELETEGET
    
"range": "string", Access list of groups enabled with SSM

    
"disable": "boolean" TRUE if SSM is disabled on this router

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/ssm/

Create operation of resource: ssm

ssm_schema

ssmbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IP Multicast SSMPUTPOSTDELETEGET
    
"range": "string", Access list of groups enabled with SSM

    
"disable": "boolean" TRUE if SSM is disabled on this router

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/ssm/

Delete operation of resource: ssm

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/ssm/

Retrieve operation of resource: ssm

200 OK
ssm_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure IP Multicast SSMPUTPOSTDELETEGET
    
"range": "string", Access list of groups enabled with SSM

    
"disable": "boolean" TRUE if SSM is disabled on this router

  }
}

BIDIR-RP-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/bidir-rp-addresses/

Update operation of resource: bidir-rp-addresses

bidir-rp-addresses_schema

bidir-rp-addressesbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

        
"rp-address": "string", RP address of Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BIDIR-RP-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/bidir-rp-addresses/

Create operation of resource: bidir-rp-addresses

bidir-rp-addresses_schema

bidir-rp-addressesbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

        
"rp-address": "string", RP address of Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BIDIR-RP-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/bidir-rp-addresses/

Delete operation of resource: bidir-rp-addresses

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BIDIR-RP-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/bidir-rp-addresses/

Retrieve operation of resource: bidir-rp-addresses

200 OK
bidir-rp-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

        
"rp-address": "string", RP address of Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}

BIDIR-RP-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/bidir-rp-addresses/bidir-rp-address/{rp-address}/

Update operation of resource: bidir-rp-address

bidir-rp-address_schema

bidir-rp-addressbody object

rp-address: string
in path

ID of rp-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

      
"rp-address": "string", RP address of Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BIDIR-RP-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/bidir-rp-addresses/bidir-rp-address/{rp-address}/

Create operation of resource: bidir-rp-address

bidir-rp-address_schema

bidir-rp-addressbody object

rp-address: string
in path

ID of rp-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

      
"rp-address": "string", RP address of Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BIDIR-RP-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/bidir-rp-addresses/bidir-rp-address/{rp-address}/

Delete operation of resource: bidir-rp-address

rp-address: string
in path

ID of rp-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BIDIR-RP-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/bidir-rp-addresses/bidir-rp-address/{rp-address}/

Retrieve operation of resource: bidir-rp-address

rp-address: string
in path

ID of rp-address

200 OK
bidir-rp-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

      
"rp-address": "string", RP address of Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}

BSR - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/bsr/

Update operation of resource: bsr

bsr_schema

bsrbody object

Request Content-Types: application/json
Request Example
{
  : {
PIM BSR configurationPUTPOSTDELETEGET
    : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
      
"priority": "string", Priority of the CRP

      
"prefix-length": "string", Hash Mask Length for this candidate BSR

      
"address": "string" Address of Candidate-RP

    },
    : {
PIM RP configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

          
"priority": "string", Priority of the CRP

          
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

          
"mode": "string", SM or Bidir

          
"address": "string" Address of Candidate-RP

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/bsr/

Create operation of resource: bsr

bsr_schema

bsrbody object

Request Content-Types: application/json
Request Example
{
  : {
PIM BSR configurationPUTPOSTDELETEGET
    : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
      
"priority": "string", Priority of the CRP

      
"prefix-length": "string", Hash Mask Length for this candidate BSR

      
"address": "string" Address of Candidate-RP

    },
    : {
PIM RP configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

          
"priority": "string", Priority of the CRP

          
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

          
"mode": "string", SM or Bidir

          
"address": "string" Address of Candidate-RP

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/bsr/

Delete operation of resource: bsr

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/bsr/

Retrieve operation of resource: bsr

200 OK
bsr_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
PIM BSR configurationPUTPOSTDELETEGET
    : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
      
"priority": "string", Priority of the CRP

      
"prefix-length": "string", Hash Mask Length for this candidate BSR

      
"address": "string" Address of Candidate-RP

    },
    : {
PIM RP configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

          
"priority": "string", Priority of the CRP

          
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

          
"mode": "string", SM or Bidir

          
"address": "string" Address of Candidate-RP

        }
      ]
    }
  }
}

CANDIDATE-BSR - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/bsr/candidate-bsr/

Update operation of resource: candidate-bsr

candidate-bsr_schema

candidate-bsrbody object

Request Content-Types: application/json
Request Example
{
  : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
    
"priority": "string", Priority of the Candidate BSR

    
"prefix-length": "string", Hash Mask Length for this candidate BSR

    
"address": "string" BSR Address configured

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-BSR - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/bsr/candidate-bsr/

Create operation of resource: candidate-bsr

candidate-bsr_schema

candidate-bsrbody object

Request Content-Types: application/json
Request Example
{
  : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
    
"priority": "string", Priority of the Candidate BSR

    
"prefix-length": "string", Hash Mask Length for this candidate BSR

    
"address": "string" BSR Address configured

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-BSR - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/bsr/candidate-bsr/

Delete operation of resource: candidate-bsr

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-BSR - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/bsr/candidate-bsr/

Retrieve operation of resource: candidate-bsr

200 OK
candidate-bsr_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
    
"priority": "string", Priority of the Candidate BSR

    
"prefix-length": "string", Hash Mask Length for this candidate BSR

    
"address": "string" BSR Address configured

  }
}

CANDIDATE-RPS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/bsr/candidate-rps/

Update operation of resource: candidate-rps

candidate-rps_schema

candidate-rpsbody object

Request Content-Types: application/json
Request Example
{
  : {
PIM RP configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

        
"priority": "string", Priority of the CRP

        
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

        
"mode": "string", SM or Bidir

        
"address": "string" Address of Candidate-RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-RPS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/bsr/candidate-rps/

Create operation of resource: candidate-rps

candidate-rps_schema

candidate-rpsbody object

Request Content-Types: application/json
Request Example
{
  : {
PIM RP configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

        
"priority": "string", Priority of the CRP

        
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

        
"mode": "string", SM or Bidir

        
"address": "string" Address of Candidate-RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-RPS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/bsr/candidate-rps/

Delete operation of resource: candidate-rps

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-RPS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/bsr/candidate-rps/

Retrieve operation of resource: candidate-rps

200 OK
candidate-rps_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
PIM RP configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

        
"priority": "string", Priority of the CRP

        
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

        
"mode": "string", SM or Bidir

        
"address": "string" Address of Candidate-RP

      }
    ]
  }
}

CANDIDATE-RP - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/bsr/candidate-rps/candidate-rp/{address mode}/

Update operation of resource: candidate-rp

candidate-rp_schema

candidate-rpbody object

address mode: string
in path

ID of address mode

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

      
"priority": "string", Priority of the CRP

      
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

      
"mode": "string", SM or Bidir

      
"address": "string" Address of Candidate-RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-RP - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/bsr/candidate-rps/candidate-rp/{address mode}/

Create operation of resource: candidate-rp

candidate-rp_schema

candidate-rpbody object

address mode: string
in path

ID of address mode

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

      
"priority": "string", Priority of the CRP

      
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

      
"mode": "string", SM or Bidir

      
"address": "string" Address of Candidate-RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-RP - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/bsr/candidate-rps/candidate-rp/{address mode}/

Delete operation of resource: candidate-rp

address mode: string
in path

ID of address mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-RP - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/bsr/candidate-rps/candidate-rp/{address mode}/

Retrieve operation of resource: candidate-rp

address mode: string
in path

ID of address mode

200 OK
candidate-rp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

      
"priority": "string", Priority of the CRP

      
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

      
"mode": "string", SM or Bidir

      
"address": "string" Address of Candidate-RP

    }
  ]
}

ALLOW-RP - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/allow-rp/

Update operation of resource: allow-rp

allow-rp_schema

allow-rpbody object

Request Content-Types: application/json
Request Example
{
  : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
    
"rp-list-name": "string", Access-list specifiying applicable RPs

    
"group-list-name": "string" Access-list specifiying applicable groups

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ALLOW-RP - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/allow-rp/

Create operation of resource: allow-rp

allow-rp_schema

allow-rpbody object

Request Content-Types: application/json
Request Example
{
  : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
    
"rp-list-name": "string", Access-list specifiying applicable RPs

    
"group-list-name": "string" Access-list specifiying applicable groups

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ALLOW-RP - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/allow-rp/

Delete operation of resource: allow-rp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ALLOW-RP - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/allow-rp/

Retrieve operation of resource: allow-rp

200 OK
allow-rp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
    
"rp-list-name": "string", Access-list specifiying applicable RPs

    
"group-list-name": "string" Access-list specifiying applicable groups

  }
}

EMBEDDED-RP-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/embedded-rp-addresses/

Update operation of resource: embedded-rp-addresses

embedded-rp-addresses_schema

embedded-rp-addressesbody object

Request Content-Types: application/json
Request Example
{
  : {
Set Embedded RP processing supportPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"rp-address": "string", RP address of the Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EMBEDDED-RP-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/embedded-rp-addresses/

Create operation of resource: embedded-rp-addresses

embedded-rp-addresses_schema

embedded-rp-addressesbody object

Request Content-Types: application/json
Request Example
{
  : {
Set Embedded RP processing supportPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"rp-address": "string", RP address of the Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EMBEDDED-RP-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/embedded-rp-addresses/

Delete operation of resource: embedded-rp-addresses

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EMBEDDED-RP-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/embedded-rp-addresses/

Retrieve operation of resource: embedded-rp-addresses

200 OK
embedded-rp-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Set Embedded RP processing supportPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"rp-address": "string", RP address of the Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}

EMBEDDED-RP-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/embedded-rp-addresses/embedded-rp-address/{rp-address}/

Update operation of resource: embedded-rp-address

embedded-rp-address_schema

embedded-rp-addressbody object

rp-address: string
in path

ID of rp-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"rp-address": "string", RP address of the Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EMBEDDED-RP-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/embedded-rp-addresses/embedded-rp-address/{rp-address}/

Create operation of resource: embedded-rp-address

embedded-rp-address_schema

embedded-rp-addressbody object

rp-address: string
in path

ID of rp-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"rp-address": "string", RP address of the Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EMBEDDED-RP-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/embedded-rp-addresses/embedded-rp-address/{rp-address}/

Delete operation of resource: embedded-rp-address

rp-address: string
in path

ID of rp-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EMBEDDED-RP-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/embedded-rp-addresses/embedded-rp-address/{rp-address}/

Retrieve operation of resource: embedded-rp-address

rp-address: string
in path

ID of rp-address

200 OK
embedded-rp-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"rp-address": "string", RP address of the Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}

CONVERGENCE - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/convergence/

Update operation of resource: convergence

convergence_schema

convergencebody object

Request Content-Types: application/json
Request Example
{
  : {
Configure convergence parametersPUTPOSTDELETEGET
    
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

    
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONVERGENCE - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/convergence/

Create operation of resource: convergence

convergence_schema

convergencebody object

Request Content-Types: application/json
Request Example
{
  : {
Configure convergence parametersPUTPOSTDELETEGET
    
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

    
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONVERGENCE - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/convergence/

Delete operation of resource: convergence

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONVERGENCE - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv6/convergence/

Retrieve operation of resource: convergence

200 OK
convergence_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure convergence parametersPUTPOSTDELETEGET
    
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

    
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

  }
}

IPV4 - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/

Update operation of resource: ipv4

ipv4_schema

ipv4body object

Request Content-Types: application/json
Request Example
{
  : {
IPV4 commandsPUTPOSTDELETEGET
    : {
Configure Candidate-RPsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"protocol-mode": "string", Protocol Mode

          
"ttl": "string", TTL in Hops

          
"access-list-name": "string", Access list of groups that should map to a\ngiven RP

          
"announce-period": "string", Time between discovery messages 

          
"interface-name": "string" The name of interface

        }
      ]
    },
    : {
Configure Non-stop forwarding (NSF) optionsPUTPOSTDELETEGET
      
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

    },
    : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"rpf-proxy-address": "string", RPF Proxy Address

          
"prefix-length": "string", Mask length

          
"source-address": "string" Source Address

        }
      ]
    },
    : [
Configure convergence parametersPUTPOSTDELETEGET
      {
        
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

        
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

      }
    ],
    
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
    : {
Configure RPF optionsPUTPOSTDELETEGET
      
"route-policy": "string" Route policy to select RPF topology

    },
    
"multipath": "string", Enable equal-cost multipath routing

    
"register-source": "string", Source address to use for register messages

    
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
    : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"rpf-proxy-address": "string", RPF Proxy Address

          
"prefix-length": "string", Mask length

          
"source-address": "string" Source Address

        }
      ]
    },
    
"neighbor-filter": "string", Access-list of neighbors to be filtered
    : [
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
      {
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

            
"rp-address": "string", RP address of Rendezvous Point

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          }
        ]
      }
    ],
    : {
Configure AutoRP Mapping AgentPUTPOSTDELETEGET
      : {
Specifications for Mapping Agent configured\non this boxPUTPOSTDELETEGET
        
"interface-name": "string", The name of interface

        
"announce-period": "string", Time between discovery messages 

        
"ttl": "string" TTL in Hops

      },
      : {
Mapping Agent cache size limitPUTPOSTDELETEGET
        
"maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"

        
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"

      }
    },
    : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
      
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    },
    
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
    : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
      
"enable": "null", Enable Multicast Only FRR

      
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

      
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

    },
    : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
      
"rp-list-name": "string", Access-list specifiying applicable RPs

      
"group-list-name": "string" Access-list specifiying applicable groups

    },
    
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol

    
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
    : {
Configure RPF-redirect featurePUTPOSTDELETEGET
      
"route-policy": "string" Route policy to select RPF topology

    },
    
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
    : {
Interface-level ConfigurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 onlyPUTPOSTDELETEGET
            
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

            
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

            
"bundle-name": "string" Bundle name

          },
          
"enable": "null", Enable Multicast Only FRR

          
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

          
"interface-name": "string", The name of interface
          : {
Maximum number of PIM routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          },
          : {
BFD configurationPUTPOSTDELETEGET
            
"enable": "boolean", Enable Multicast Only FRR

            
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

            
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

          },
          
"neighbor-filter": "string", Access-list of neighbors to be filtered

          
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

          
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

          
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

          
"interface-enable": "boolean", Enable PIM processing on the interface

          
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

          
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

          
"bsr-border": "boolean" BSR Border configuration for Interface

        }
      ]
    },
    : {
PIM BSR configurationPUTPOSTDELETEGET
      : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
        
"priority": "string", Priority of the CRP

        
"prefix-length": "string", Mask length

        
"address": "string" Address of Candidate-RP

      },
      : {
PIM RP configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

            
"priority": "string", Priority of the CRP

            
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

            
"mode": "string", SM or Bidir

            
"address": "string" Address of Candidate-RP

          }
        ]
      }
    },
    : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
      
"enable": "null", Enable Multicast Only FRR

      
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

      
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
      : {
Clone multicast joinsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"source": "string", Original source address (S)

            
"prefix-length": "string", Mask length

            
"backup": "string", Backup cloned address (S2)

            
"primary": "string" Primary cloned address (S1)

          }
        ]
      },
      : {
Clone multicast trafficPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"source": "string", Original source address (S)

            
"prefix-length": "string", Mask length

            
"backup": "string", Backup cloned address (S2)

            
"primary": "string" Primary cloned address (S1)

          }
        ]
      },
      
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

    },
    : {
Configure IP Multicast SSMPUTPOSTDELETEGET
      
"range": "string", Access list of groups enabled with SSM

      
"disable": "boolean" TRUE if SSM is disabled on this router

    },
    
"rp-static-deny": "string", Configure static RP deny range

    
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
    : {
Inheritable defaultsPUTPOSTDELETEGET
      
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

      
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

      
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

      
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

      
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

      
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

      
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

    },
    : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

          
"rp-address": "string", RP address of Rendezvous Point

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        }
      ]
    },
    
"accept-register": "string", Access-list which specifies unauthorized sources

    
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
    : {
Configure PIM State LimitsPUTPOSTDELETEGET
      
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
      : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
        
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

        
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

      },
      : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
        
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

        
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

      },
      : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
        
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

      },
      : {
Override default maximum for number of routesPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

      },
      : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
        
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
        
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

      },
      
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
      : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
        
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum for number of routesPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

      },
      : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
        
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

      }
    },
    
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/

Create operation of resource: ipv4

ipv4_schema

ipv4body object

Request Content-Types: application/json
Request Example
{
  : {
IPV4 commandsPUTPOSTDELETEGET
    : {
Configure Candidate-RPsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"protocol-mode": "string", Protocol Mode

          
"ttl": "string", TTL in Hops

          
"access-list-name": "string", Access list of groups that should map to a\ngiven RP

          
"announce-period": "string", Time between discovery messages 

          
"interface-name": "string" The name of interface

        }
      ]
    },
    : {
Configure Non-stop forwarding (NSF) optionsPUTPOSTDELETEGET
      
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

    },
    : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"rpf-proxy-address": "string", RPF Proxy Address

          
"prefix-length": "string", Mask length

          
"source-address": "string" Source Address

        }
      ]
    },
    : [
Configure convergence parametersPUTPOSTDELETEGET
      {
        
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

        
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

      }
    ],
    
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
    : {
Configure RPF optionsPUTPOSTDELETEGET
      
"route-policy": "string" Route policy to select RPF topology

    },
    
"multipath": "string", Enable equal-cost multipath routing

    
"register-source": "string", Source address to use for register messages

    
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
    : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"rpf-proxy-address": "string", RPF Proxy Address

          
"prefix-length": "string", Mask length

          
"source-address": "string" Source Address

        }
      ]
    },
    
"neighbor-filter": "string", Access-list of neighbors to be filtered
    : [
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
      {
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

            
"rp-address": "string", RP address of Rendezvous Point

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          }
        ]
      }
    ],
    : {
Configure AutoRP Mapping AgentPUTPOSTDELETEGET
      : {
Specifications for Mapping Agent configured\non this boxPUTPOSTDELETEGET
        
"interface-name": "string", The name of interface

        
"announce-period": "string", Time between discovery messages 

        
"ttl": "string" TTL in Hops

      },
      : {
Mapping Agent cache size limitPUTPOSTDELETEGET
        
"maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"

        
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"

      }
    },
    : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
      
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    },
    
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
    : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
      
"enable": "null", Enable Multicast Only FRR

      
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

      
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

    },
    : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
      
"rp-list-name": "string", Access-list specifiying applicable RPs

      
"group-list-name": "string" Access-list specifiying applicable groups

    },
    
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol

    
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
    : {
Configure RPF-redirect featurePUTPOSTDELETEGET
      
"route-policy": "string" Route policy to select RPF topology

    },
    
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
    : {
Interface-level ConfigurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 onlyPUTPOSTDELETEGET
            
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

            
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

            
"bundle-name": "string" Bundle name

          },
          
"enable": "null", Enable Multicast Only FRR

          
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

          
"interface-name": "string", The name of interface
          : {
Maximum number of PIM routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          },
          : {
BFD configurationPUTPOSTDELETEGET
            
"enable": "boolean", Enable Multicast Only FRR

            
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

            
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

          },
          
"neighbor-filter": "string", Access-list of neighbors to be filtered

          
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

          
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

          
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

          
"interface-enable": "boolean", Enable PIM processing on the interface

          
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

          
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

          
"bsr-border": "boolean" BSR Border configuration for Interface

        }
      ]
    },
    : {
PIM BSR configurationPUTPOSTDELETEGET
      : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
        
"priority": "string", Priority of the CRP

        
"prefix-length": "string", Mask length

        
"address": "string" Address of Candidate-RP

      },
      : {
PIM RP configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

            
"priority": "string", Priority of the CRP

            
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

            
"mode": "string", SM or Bidir

            
"address": "string" Address of Candidate-RP

          }
        ]
      }
    },
    : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
      
"enable": "null", Enable Multicast Only FRR

      
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

      
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
      : {
Clone multicast joinsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"source": "string", Original source address (S)

            
"prefix-length": "string", Mask length

            
"backup": "string", Backup cloned address (S2)

            
"primary": "string" Primary cloned address (S1)

          }
        ]
      },
      : {
Clone multicast trafficPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"source": "string", Original source address (S)

            
"prefix-length": "string", Mask length

            
"backup": "string", Backup cloned address (S2)

            
"primary": "string" Primary cloned address (S1)

          }
        ]
      },
      
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

    },
    : {
Configure IP Multicast SSMPUTPOSTDELETEGET
      
"range": "string", Access list of groups enabled with SSM

      
"disable": "boolean" TRUE if SSM is disabled on this router

    },
    
"rp-static-deny": "string", Configure static RP deny range

    
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
    : {
Inheritable defaultsPUTPOSTDELETEGET
      
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

      
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

      
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

      
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

      
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

      
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

      
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

    },
    : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

          
"rp-address": "string", RP address of Rendezvous Point

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        }
      ]
    },
    
"accept-register": "string", Access-list which specifies unauthorized sources

    
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
    : {
Configure PIM State LimitsPUTPOSTDELETEGET
      
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
      : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
        
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

        
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

      },
      : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
        
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

        
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

      },
      : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
        
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

      },
      : {
Override default maximum for number of routesPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

      },
      : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
        
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
        
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

      },
      
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
      : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
        
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum for number of routesPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

      },
      : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
        
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

      }
    },
    
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/

Delete operation of resource: ipv4

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/

Retrieve operation of resource: ipv4

200 OK
ipv4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IPV4 commandsPUTPOSTDELETEGET
    : {
Configure Candidate-RPsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"protocol-mode": "string", Protocol Mode

          
"ttl": "string", TTL in Hops

          
"access-list-name": "string", Access list of groups that should map to a\ngiven RP

          
"announce-period": "string", Time between discovery messages 

          
"interface-name": "string" The name of interface

        }
      ]
    },
    : {
Configure Non-stop forwarding (NSF) optionsPUTPOSTDELETEGET
      
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

    },
    : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"rpf-proxy-address": "string", RPF Proxy Address

          
"prefix-length": "string", Mask length

          
"source-address": "string" Source Address

        }
      ]
    },
    : [
Configure convergence parametersPUTPOSTDELETEGET
      {
        
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

        
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

      }
    ],
    
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges
    : {
Configure RPF optionsPUTPOSTDELETEGET
      
"route-policy": "string" Route policy to select RPF topology

    },
    
"multipath": "string", Enable equal-cost multipath routing

    
"register-source": "string", Source address to use for register messages

    
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
    : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"rpf-proxy-address": "string", RPF Proxy Address

          
"prefix-length": "string", Mask length

          
"source-address": "string" Source Address

        }
      ]
    },
    
"neighbor-filter": "string", Access-list of neighbors to be filtered
    : [
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
      {
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

            
"rp-address": "string", RP address of Rendezvous Point

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          }
        ]
      }
    ],
    : {
Configure AutoRP Mapping AgentPUTPOSTDELETEGET
      : {
Specifications for Mapping Agent configured\non this boxPUTPOSTDELETEGET
        
"interface-name": "string", The name of interface

        
"announce-period": "string", Time between discovery messages 

        
"ttl": "string" TTL in Hops

      },
      : {
Mapping Agent cache size limitPUTPOSTDELETEGET
        
"maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"

        
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"

      }
    },
    : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
      
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    },
    
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions
    : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
      
"enable": "null", Enable Multicast Only FRR

      
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

      
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

    },
    : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
      
"rp-list-name": "string", Access-list specifiying applicable RPs

      
"group-list-name": "string" Access-list specifiying applicable groups

    },
    
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol

    
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
    : {
Configure RPF-redirect featurePUTPOSTDELETEGET
      
"route-policy": "string" Route policy to select RPF topology

    },
    
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured
    : {
Interface-level ConfigurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 onlyPUTPOSTDELETEGET
            
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

            
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

            
"bundle-name": "string" Bundle name

          },
          
"enable": "null", Enable Multicast Only FRR

          
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

          
"interface-name": "string", The name of interface
          : {
Maximum number of PIM routesPUTPOSTDELETEGET
            
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

            
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"

            
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

          },
          : {
BFD configurationPUTPOSTDELETEGET
            
"enable": "boolean", Enable Multicast Only FRR

            
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

            
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"

          },
          
"neighbor-filter": "string", Access-list of neighbors to be filtered

          
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

          
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

          
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

          
"interface-enable": "boolean", Enable PIM processing on the interface

          
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

          
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

          
"bsr-border": "boolean" BSR Border configuration for Interface

        }
      ]
    },
    : {
PIM BSR configurationPUTPOSTDELETEGET
      : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
        
"priority": "string", Priority of the CRP

        
"prefix-length": "string", Mask length

        
"address": "string" Address of Candidate-RP

      },
      : {
PIM RP configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

            
"priority": "string", Priority of the CRP

            
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

            
"mode": "string", SM or Bidir

            
"address": "string" Address of Candidate-RP

          }
        ]
      }
    },
    : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
      
"enable": "null", Enable Multicast Only FRR

      
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

      
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
      : {
Clone multicast joinsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"source": "string", Original source address (S)

            
"prefix-length": "string", Mask length

            
"backup": "string", Backup cloned address (S2)

            
"primary": "string" Primary cloned address (S1)

          }
        ]
      },
      : {
Clone multicast trafficPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"source": "string", Original source address (S)

            
"prefix-length": "string", Mask length

            
"backup": "string", Backup cloned address (S2)

            
"primary": "string" Primary cloned address (S1)

          }
        ]
      },
      
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

    },
    : {
Configure IP Multicast SSMPUTPOSTDELETEGET
      
"range": "string", Access list of groups enabled with SSM

      
"disable": "boolean" TRUE if SSM is disabled on this router

    },
    
"rp-static-deny": "string", Configure static RP deny range

    
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop
    : {
Inheritable defaultsPUTPOSTDELETEGET
      
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

      
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

      
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

      
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

      
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

      
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

      
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

    },
    : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

          
"rp-address": "string", RP address of Rendezvous Point

          
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

        }
      ]
    },
    
"accept-register": "string", Access-list which specifies unauthorized sources

    
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup
    : {
Configure PIM State LimitsPUTPOSTDELETEGET
      
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
      : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
        
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

        
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

      },
      : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
        
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

        
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

      },
      : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
        
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

      },
      : {
Override default maximum for number of routesPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

      },
      : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
        
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
        
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

      },
      
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
      : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
        
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default maximum for number of routesPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

      },
      : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
        
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

        
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

      },
      : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

      }
    },
    
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges

  }
}

RPF-REDIRECT - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/rpf-redirect/

Update operation of resource: rpf-redirect

rpf-redirect_schema

rpf-redirectbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure RPF-redirect featurePUTPOSTDELETEGET
    
"route-policy": "string" Route policy to select RPF topology

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF-REDIRECT - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/rpf-redirect/

Create operation of resource: rpf-redirect

rpf-redirect_schema

rpf-redirectbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure RPF-redirect featurePUTPOSTDELETEGET
    
"route-policy": "string" Route policy to select RPF topology

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF-REDIRECT - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/rpf-redirect/

Delete operation of resource: rpf-redirect

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF-REDIRECT - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/rpf-redirect/

Retrieve operation of resource: rpf-redirect

200 OK
rpf-redirect_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure RPF-redirect featurePUTPOSTDELETEGET
    
"route-policy": "string" Route policy to select RPF topology

  }
}

INTERFACES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/interfaces/

Update operation of resource: interfaces

interfaces_schema

interfacesbody object

Request Content-Types: application/json
Request Example
{
  : {
Interface-level ConfigurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 onlyPUTPOSTDELETEGET
          
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

          
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

          
"bundle-name": "string" Bundle name

        },
        
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

        
"interface-name": "string", The name of interface
        : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

          
"access-list-name": "string" Access-list to account for

        },
        : {
BFD configurationPUTPOSTDELETEGET
          
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

          
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

        },
        
"neighbor-filter": "string", Access-list of neighbors to be filtered

        
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

        
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

        
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

        
"interface-enable": "boolean", Enable PIM processing on the interface

        
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

        
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

        
"bsr-border": "boolean" BSR Border configuration for Interface

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/interfaces/

Create operation of resource: interfaces

interfaces_schema

interfacesbody object

Request Content-Types: application/json
Request Example
{
  : {
Interface-level ConfigurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 onlyPUTPOSTDELETEGET
          
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

          
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

          
"bundle-name": "string" Bundle name

        },
        
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

        
"interface-name": "string", The name of interface
        : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

          
"access-list-name": "string" Access-list to account for

        },
        : {
BFD configurationPUTPOSTDELETEGET
          
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

          
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

        },
        
"neighbor-filter": "string", Access-list of neighbors to be filtered

        
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

        
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

        
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

        
"interface-enable": "boolean", Enable PIM processing on the interface

        
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

        
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

        
"bsr-border": "boolean" BSR Border configuration for Interface

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/interfaces/

Delete operation of resource: interfaces

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/interfaces/

Retrieve operation of resource: interfaces

200 OK
interfaces_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Interface-level ConfigurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 onlyPUTPOSTDELETEGET
          
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

          
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

          
"bundle-name": "string" Bundle name

        },
        
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

        
"interface-name": "string", The name of interface
        : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
          
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

          
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

          
"access-list-name": "string" Access-list to account for

        },
        : {
BFD configurationPUTPOSTDELETEGET
          
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

          
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

          
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

        },
        
"neighbor-filter": "string", Access-list of neighbors to be filtered

        
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

        
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

        
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

        
"interface-enable": "boolean", Enable PIM processing on the interface

        
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

        
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

        
"bsr-border": "boolean" BSR Border configuration for Interface

      }
    ]
  }
}

INTERFACE - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/interfaces/interface/{interface-name}/

Update operation of resource: interface

interface_schema

interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 onlyPUTPOSTDELETEGET
        
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

        
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

        
"bundle-name": "string" Bundle name

      },
      
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

      
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

      
"interface-name": "string", The name of interface
      : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

        
"access-list-name": "string" Access-list to account for

      },
      : {
BFD configurationPUTPOSTDELETEGET
        
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

        
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

      },
      
"neighbor-filter": "string", Access-list of neighbors to be filtered

      
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

      
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

      
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

      
"interface-enable": "boolean", Enable PIM processing on the interface

      
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

      
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

      
"bsr-border": "boolean" BSR Border configuration for Interface

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/interfaces/interface/{interface-name}/

Create operation of resource: interface

interface_schema

interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 onlyPUTPOSTDELETEGET
        
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

        
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

        
"bundle-name": "string" Bundle name

      },
      
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

      
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

      
"interface-name": "string", The name of interface
      : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

        
"access-list-name": "string" Access-list to account for

      },
      : {
BFD configurationPUTPOSTDELETEGET
        
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

        
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

      },
      
"neighbor-filter": "string", Access-list of neighbors to be filtered

      
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

      
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

      
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

      
"interface-enable": "boolean", Enable PIM processing on the interface

      
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

      
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

      
"bsr-border": "boolean" BSR Border configuration for Interface

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/interfaces/interface/{interface-name}/

Delete operation of resource: interface

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/interfaces/interface/{interface-name}/

Retrieve operation of resource: interface

interface-name: string
in path

ID of interface-name

200 OK
interface_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 onlyPUTPOSTDELETEGET
        
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

        
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

        
"bundle-name": "string" Bundle name

      },
      
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

      
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

      
"interface-name": "string", The name of interface
      : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
        
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

        
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

        
"access-list-name": "string" Access-list to account for

      },
      : {
BFD configurationPUTPOSTDELETEGET
        
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

        
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

        
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

      },
      
"neighbor-filter": "string", Access-list of neighbors to be filtered

      
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

      
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

      
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

      
"interface-enable": "boolean", Enable PIM processing on the interface

      
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

      
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

      
"bsr-border": "boolean" BSR Border configuration for Interface

    }
  ]
}

REDIRECT-BUNDLE - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/interfaces/interface/{interface-name}/redirect-bundle/

Update operation of resource: redirect-bundle

redirect-bundle_schema

redirect-bundlebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 onlyPUTPOSTDELETEGET
    
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

    
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

    
"bundle-name": "string" Bundle name

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REDIRECT-BUNDLE - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/interfaces/interface/{interface-name}/redirect-bundle/

Create operation of resource: redirect-bundle

redirect-bundle_schema

redirect-bundlebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 onlyPUTPOSTDELETEGET
    
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

    
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

    
"bundle-name": "string" Bundle name

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REDIRECT-BUNDLE - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/interfaces/interface/{interface-name}/redirect-bundle/

Delete operation of resource: redirect-bundle

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REDIRECT-BUNDLE - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/interfaces/interface/{interface-name}/redirect-bundle/

Retrieve operation of resource: redirect-bundle

interface-name: string
in path

ID of interface-name

200 OK
redirect-bundle_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure RPF-redirect bundle for interface.\nApplicable for IPv4 onlyPUTPOSTDELETEGET
    
"interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

    
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"

    
"bundle-name": "string" Bundle name

  }
}

MAXIMUM-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/interfaces/interface/{interface-name}/maximum-routes/

Update operation of resource: maximum-routes

maximum-routes_schema

maximum-routesbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

    
"access-list-name": "string" Access-list to account for

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-ROUTES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/interfaces/interface/{interface-name}/maximum-routes/

Create operation of resource: maximum-routes

maximum-routes_schema

maximum-routesbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

    
"access-list-name": "string" Access-list to account for

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/interfaces/interface/{interface-name}/maximum-routes/

Delete operation of resource: maximum-routes

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/interfaces/interface/{interface-name}/maximum-routes/

Retrieve operation of resource: maximum-routes

interface-name: string
in path

ID of interface-name

200 OK
maximum-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Maximum number of allowed routes for this\ninterfacePUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"

    
"access-list-name": "string" Access-list to account for

  }
}

BFD - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/interfaces/interface/{interface-name}/bfd/

Update operation of resource: bfd

bfd_schema

bfdbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
BFD configurationPUTPOSTDELETEGET
    
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

    
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

    
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BFD - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/interfaces/interface/{interface-name}/bfd/

Create operation of resource: bfd

bfd_schema

bfdbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
BFD configurationPUTPOSTDELETEGET
    
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

    
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

    
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BFD - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/interfaces/interface/{interface-name}/bfd/

Delete operation of resource: bfd

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BFD - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/interfaces/interface/{interface-name}/bfd/

Retrieve operation of resource: bfd

interface-name: string
in path

ID of interface-name

200 OK
bfd_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
BFD configurationPUTPOSTDELETEGET
    
"enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent

    
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"

    
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"

  }
}

AUTO-RP-CANDIDATE-RPS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/auto-rp-candidate-rps/

Update operation of resource: auto-rp-candidate-rps

auto-rp-candidate-rps_schema

auto-rp-candidate-rpsbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure Candidate-RPsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"protocol-mode": "string", Protocol Mode

        
"ttl": "string", TTL in Hops

        
"access-list-name": "string", Access-list specifying the group range for\nthe Candidate-RP

        
"announce-period": "string", Time between announcements  

        
"interface-name": "string" Interface from which Candidate-RP packets\nwill be sourced

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AUTO-RP-CANDIDATE-RPS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/auto-rp-candidate-rps/

Create operation of resource: auto-rp-candidate-rps

auto-rp-candidate-rps_schema

auto-rp-candidate-rpsbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure Candidate-RPsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"protocol-mode": "string", Protocol Mode

        
"ttl": "string", TTL in Hops

        
"access-list-name": "string", Access-list specifying the group range for\nthe Candidate-RP

        
"announce-period": "string", Time between announcements  

        
"interface-name": "string" Interface from which Candidate-RP packets\nwill be sourced

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AUTO-RP-CANDIDATE-RPS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/auto-rp-candidate-rps/

Delete operation of resource: auto-rp-candidate-rps

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AUTO-RP-CANDIDATE-RPS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/auto-rp-candidate-rps/

Retrieve operation of resource: auto-rp-candidate-rps

200 OK
auto-rp-candidate-rps_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure Candidate-RPsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"protocol-mode": "string", Protocol Mode

        
"ttl": "string", TTL in Hops

        
"access-list-name": "string", Access-list specifying the group range for\nthe Candidate-RP

        
"announce-period": "string", Time between announcements  

        
"interface-name": "string" Interface from which Candidate-RP packets\nwill be sourced

      }
    ]
  }
}

AUTO-RP-CANDIDATE-RP - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/auto-rp-candidate-rps/auto-rp-candidate-rp/{interface-name protocol-mode}/

Update operation of resource: auto-rp-candidate-rp

auto-rp-candidate-rp_schema

auto-rp-candidate-rpbody object

interface-name protocol-mode: string
in path

ID of interface-name protocol-mode

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"protocol-mode": "string", Protocol Mode

      
"ttl": "string", TTL in Hops

      
"access-list-name": "string", Access-list specifying the group range for\nthe Candidate-RP

      
"announce-period": "string", Time between announcements  

      
"interface-name": "string" Interface from which Candidate-RP packets\nwill be sourced

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AUTO-RP-CANDIDATE-RP - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/auto-rp-candidate-rps/auto-rp-candidate-rp/{interface-name protocol-mode}/

Create operation of resource: auto-rp-candidate-rp

auto-rp-candidate-rp_schema

auto-rp-candidate-rpbody object

interface-name protocol-mode: string
in path

ID of interface-name protocol-mode

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"protocol-mode": "string", Protocol Mode

      
"ttl": "string", TTL in Hops

      
"access-list-name": "string", Access-list specifying the group range for\nthe Candidate-RP

      
"announce-period": "string", Time between announcements  

      
"interface-name": "string" Interface from which Candidate-RP packets\nwill be sourced

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AUTO-RP-CANDIDATE-RP - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/auto-rp-candidate-rps/auto-rp-candidate-rp/{interface-name protocol-mode}/

Delete operation of resource: auto-rp-candidate-rp

interface-name protocol-mode: string
in path

ID of interface-name protocol-mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AUTO-RP-CANDIDATE-RP - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/auto-rp-candidate-rps/auto-rp-candidate-rp/{interface-name protocol-mode}/

Retrieve operation of resource: auto-rp-candidate-rp

interface-name protocol-mode: string
in path

ID of interface-name protocol-mode

200 OK
auto-rp-candidate-rp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"protocol-mode": "string", Protocol Mode

      
"ttl": "string", TTL in Hops

      
"access-list-name": "string", Access-list specifying the group range for\nthe Candidate-RP

      
"announce-period": "string", Time between announcements  

      
"interface-name": "string" Interface from which Candidate-RP packets\nwill be sourced

    }
  ]
}

AUTO-RP-MAPPING-AGENT - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/auto-rp-mapping-agent/

Update operation of resource: auto-rp-mapping-agent

auto-rp-mapping-agent_schema

auto-rp-mapping-agentbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure AutoRP Mapping AgentPUTPOSTDELETEGET
    : {
Specifications for Mapping Agent configured\non this boxPUTPOSTDELETEGET
      
"interface-name": "string", Interface from which mapping packets will be\nsourced 

      
"announce-period": "string", Time between discovery messages 

      
"ttl": "string" TTL in Hops

    },
    : {
Mapping Agent cache size limitPUTPOSTDELETEGET
      
"maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"

      
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AUTO-RP-MAPPING-AGENT - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/auto-rp-mapping-agent/

Create operation of resource: auto-rp-mapping-agent

auto-rp-mapping-agent_schema

auto-rp-mapping-agentbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure AutoRP Mapping AgentPUTPOSTDELETEGET
    : {
Specifications for Mapping Agent configured\non this boxPUTPOSTDELETEGET
      
"interface-name": "string", Interface from which mapping packets will be\nsourced 

      
"announce-period": "string", Time between discovery messages 

      
"ttl": "string" TTL in Hops

    },
    : {
Mapping Agent cache size limitPUTPOSTDELETEGET
      
"maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"

      
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AUTO-RP-MAPPING-AGENT - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/auto-rp-mapping-agent/

Delete operation of resource: auto-rp-mapping-agent

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AUTO-RP-MAPPING-AGENT - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/auto-rp-mapping-agent/

Retrieve operation of resource: auto-rp-mapping-agent

200 OK
auto-rp-mapping-agent_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure AutoRP Mapping AgentPUTPOSTDELETEGET
    : {
Specifications for Mapping Agent configured\non this boxPUTPOSTDELETEGET
      
"interface-name": "string", Interface from which mapping packets will be\nsourced 

      
"announce-period": "string", Time between discovery messages 

      
"ttl": "string" TTL in Hops

    },
    : {
Mapping Agent cache size limitPUTPOSTDELETEGET
      
"maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"

      
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"

    }
  }
}

PARAMETERS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/auto-rp-mapping-agent/parameters/

Update operation of resource: parameters

parameters_schema

parametersbody object

Request Content-Types: application/json
Request Example
{
  : {
Specifications for Mapping Agent configured\non this boxPUTPOSTDELETEGET
    
"interface-name": "string", Interface from which mapping packets will be\nsourced 

    
"announce-period": "string", Time between discovery messages 

    
"ttl": "string" TTL in Hops

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PARAMETERS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/auto-rp-mapping-agent/parameters/

Create operation of resource: parameters

parameters_schema

parametersbody object

Request Content-Types: application/json
Request Example
{
  : {
Specifications for Mapping Agent configured\non this boxPUTPOSTDELETEGET
    
"interface-name": "string", Interface from which mapping packets will be\nsourced 

    
"announce-period": "string", Time between discovery messages 

    
"ttl": "string" TTL in Hops

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PARAMETERS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/auto-rp-mapping-agent/parameters/

Delete operation of resource: parameters

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PARAMETERS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/auto-rp-mapping-agent/parameters/

Retrieve operation of resource: parameters

200 OK
parameters_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Specifications for Mapping Agent configured\non this boxPUTPOSTDELETEGET
    
"interface-name": "string", Interface from which mapping packets will be\nsourced 

    
"announce-period": "string", Time between discovery messages 

    
"ttl": "string" TTL in Hops

  }
}

CACHE-LIMIT - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/auto-rp-mapping-agent/cache-limit/

Update operation of resource: cache-limit

cache-limit_schema

cache-limitbody object

Request Content-Types: application/json
Request Example
{
  : {
Mapping Agent cache size limitPUTPOSTDELETEGET
    
"maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"

    
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CACHE-LIMIT - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/auto-rp-mapping-agent/cache-limit/

Create operation of resource: cache-limit

cache-limit_schema

cache-limitbody object

Request Content-Types: application/json
Request Example
{
  : {
Mapping Agent cache size limitPUTPOSTDELETEGET
    
"maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"

    
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CACHE-LIMIT - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/auto-rp-mapping-agent/cache-limit/

Delete operation of resource: cache-limit

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CACHE-LIMIT - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/auto-rp-mapping-agent/cache-limit/

Retrieve operation of resource: cache-limit

200 OK
cache-limit_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Mapping Agent cache size limitPUTPOSTDELETEGET
    
"maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"

    
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"

  }
}

SPARSE-MODE-RP-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/sparse-mode-rp-addresses/

Update operation of resource: sparse-mode-rp-addresses

sparse-mode-rp-addresses_schema

sparse-mode-rp-addressesbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

        
"rp-address": "string", RP address of Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SPARSE-MODE-RP-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/sparse-mode-rp-addresses/

Create operation of resource: sparse-mode-rp-addresses

sparse-mode-rp-addresses_schema

sparse-mode-rp-addressesbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

        
"rp-address": "string", RP address of Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SPARSE-MODE-RP-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/sparse-mode-rp-addresses/

Delete operation of resource: sparse-mode-rp-addresses

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SPARSE-MODE-RP-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/sparse-mode-rp-addresses/

Retrieve operation of resource: sparse-mode-rp-addresses

200 OK
sparse-mode-rp-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure Sparse-Mode Rendezvous PointPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

        
"rp-address": "string", RP address of Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}

SPARSE-MODE-RP-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/sparse-mode-rp-addresses/sparse-mode-rp-address/{rp-address}/

Update operation of resource: sparse-mode-rp-address

sparse-mode-rp-address_schema

sparse-mode-rp-addressbody object

rp-address: string
in path

ID of rp-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

      
"rp-address": "string", RP address of Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SPARSE-MODE-RP-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/sparse-mode-rp-addresses/sparse-mode-rp-address/{rp-address}/

Create operation of resource: sparse-mode-rp-address

sparse-mode-rp-address_schema

sparse-mode-rp-addressbody object

rp-address: string
in path

ID of rp-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

      
"rp-address": "string", RP address of Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SPARSE-MODE-RP-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/sparse-mode-rp-addresses/sparse-mode-rp-address/{rp-address}/

Delete operation of resource: sparse-mode-rp-address

rp-address: string
in path

ID of rp-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SPARSE-MODE-RP-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/sparse-mode-rp-addresses/sparse-mode-rp-address/{rp-address}/

Retrieve operation of resource: sparse-mode-rp-address

rp-address: string
in path

ID of rp-address

200 OK
sparse-mode-rp-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

      
"rp-address": "string", RP address of Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}

INHERITABLE-DEFAULTS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/inheritable-defaults/

Update operation of resource: inheritable-defaults

inheritable-defaults_schema

inheritable-defaultsbody object

Request Content-Types: application/json
Request Example
{
  : {
Inheritable defaultsPUTPOSTDELETEGET
    
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

    
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

    
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

    
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

    
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

    
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

    
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERITABLE-DEFAULTS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/inheritable-defaults/

Create operation of resource: inheritable-defaults

inheritable-defaults_schema

inheritable-defaultsbody object

Request Content-Types: application/json
Request Example
{
  : {
Inheritable defaultsPUTPOSTDELETEGET
    
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

    
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

    
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

    
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

    
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

    
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

    
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERITABLE-DEFAULTS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/inheritable-defaults/

Delete operation of resource: inheritable-defaults

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERITABLE-DEFAULTS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/inheritable-defaults/

Retrieve operation of resource: inheritable-defaults

200 OK
inheritable-defaults_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Inheritable defaultsPUTPOSTDELETEGET
    
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"

    
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"

    
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"

    
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"

    
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"

    
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"

    
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"

  }
}

RPF - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/rpf/

Update operation of resource: rpf

rpf_schema

rpfbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure RPF optionsPUTPOSTDELETEGET
    
"route-policy": "string" Route policy to select RPF topology

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/rpf/

Create operation of resource: rpf

rpf_schema

rpfbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure RPF optionsPUTPOSTDELETEGET
    
"route-policy": "string" Route policy to select RPF topology

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/rpf/

Delete operation of resource: rpf

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/rpf/

Retrieve operation of resource: rpf

200 OK
rpf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure RPF optionsPUTPOSTDELETEGET
    
"route-policy": "string" Route policy to select RPF topology

  }
}

SG-EXPIRY-TIMER - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/sg-expiry-timer/

Update operation of resource: sg-expiry-timer

sg-expiry-timer_schema

sg-expiry-timerbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
    
"interval": "integer", (S,G) expiry time in seconds
range: "30..600"
units: "second"
default: "60"

    
"access-list-name": "string" Access-list of applicable S,G routes

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SG-EXPIRY-TIMER - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/sg-expiry-timer/

Create operation of resource: sg-expiry-timer

sg-expiry-timer_schema

sg-expiry-timerbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
    
"interval": "integer", (S,G) expiry time in seconds
range: "30..600"
units: "second"
default: "60"

    
"access-list-name": "string" Access-list of applicable S,G routes

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SG-EXPIRY-TIMER - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/sg-expiry-timer/

Delete operation of resource: sg-expiry-timer

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SG-EXPIRY-TIMER - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/sg-expiry-timer/

Retrieve operation of resource: sg-expiry-timer

200 OK
sg-expiry-timer_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure expiry timer for S,G routesPUTPOSTDELETEGET
    
"interval": "integer", (S,G) expiry time in seconds
range: "30..600"
units: "second"
default: "60"

    
"access-list-name": "string" Access-list of applicable S,G routes

  }
}

RPF-VECTOR-ENABLE - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/rpf-vector-enable/

Update operation of resource: rpf-vector-enable

rpf-vector-enable_schema

rpf-vector-enablebody object

Request Content-Types: application/json
Request Example
{
  : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
    
"enable": "null", RPF Vector is turned on if configured

    
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

    
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF-VECTOR-ENABLE - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/rpf-vector-enable/

Create operation of resource: rpf-vector-enable

rpf-vector-enable_schema

rpf-vector-enablebody object

Request Content-Types: application/json
Request Example
{
  : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
    
"enable": "null", RPF Vector is turned on if configured

    
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

    
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF-VECTOR-ENABLE - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/rpf-vector-enable/

Delete operation of resource: rpf-vector-enable

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RPF-VECTOR-ENABLE - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/rpf-vector-enable/

Retrieve operation of resource: rpf-vector-enable

200 OK
rpf-vector-enable_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Enable PIM RPF Vector Proxy'sPUTPOSTDELETEGET
    
"enable": "null", RPF Vector is turned on if configured

    
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions

    
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions

  }
}

NSF - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/nsf/

Update operation of resource: nsf

nsf_schema

nsfbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure Non-stop forwarding (NSF) optionsPUTPOSTDELETEGET
    
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NSF - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/nsf/

Create operation of resource: nsf

nsf_schema

nsfbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure Non-stop forwarding (NSF) optionsPUTPOSTDELETEGET
    
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NSF - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/nsf/

Delete operation of resource: nsf

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NSF - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/nsf/

Retrieve operation of resource: nsf

200 OK
nsf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure Non-stop forwarding (NSF) optionsPUTPOSTDELETEGET
    
"lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"

  }
}

MAXIMUM - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/

Update operation of resource: maximum

maximum_schema

maximumbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure PIM State LimitsPUTPOSTDELETEGET
    
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
    : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
      
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

      
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

    },
    : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
      
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

      
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

    },
    : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
      
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

    },
    : {
Override default maximum for number of routesPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

    },
    : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
      
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
      
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

    },
    
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
    : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
      
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum for number of routesPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

    },
    : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
      
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/

Create operation of resource: maximum

maximum_schema

maximumbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure PIM State LimitsPUTPOSTDELETEGET
    
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
    : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
      
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

      
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

    },
    : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
      
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

      
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

    },
    : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
      
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

    },
    : {
Override default maximum for number of routesPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

    },
    : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
      
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
      
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

    },
    
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
    : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
      
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum for number of routesPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

    },
    : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
      
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/

Delete operation of resource: maximum

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/

Retrieve operation of resource: maximum

200 OK
maximum_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure PIM State LimitsPUTPOSTDELETEGET
    
"global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
    : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
      
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

      
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

    },
    : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
      
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

      
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

    },
    : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
      
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

    },
    : {
Override default maximum for number of routesPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

    },
    : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
      
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
      
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

    },
    
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte"
    : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
      
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default maximum for number of routesPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

    },
    : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
      
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

      
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

    },
    : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
      
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

      
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

    }
  }
}

BSR-GLOBAL-GROUP-MAPPINGS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/bsr-global-group-mappings/

Update operation of resource: bsr-global-group-mappings

bsr-global-group-mappings_schema

bsr-global-group-mappingsbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-GLOBAL-GROUP-MAPPINGS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/bsr-global-group-mappings/

Create operation of resource: bsr-global-group-mappings

bsr-global-group-mappings_schema

bsr-global-group-mappingsbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-GLOBAL-GROUP-MAPPINGS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/bsr-global-group-mappings/

Delete operation of resource: bsr-global-group-mappings

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-GLOBAL-GROUP-MAPPINGS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/bsr-global-group-mappings/

Retrieve operation of resource: bsr-global-group-mappings

200 OK
bsr-global-group-mappings_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default global maximum and threshold\nfor PIM group mapping ranges from BSRPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"

  }
}

GLOBAL-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/global-routes/

Update operation of resource: global-routes

global-routes_schema

global-routesbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of routesPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-ROUTES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/global-routes/

Create operation of resource: global-routes

global-routes_schema

global-routesbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of routesPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/global-routes/

Delete operation of resource: global-routes

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/global-routes/

Retrieve operation of resource: global-routes

200 OK
global-routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum for number of routesPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

  }
}

GLOBAL-GROUP-MAPPINGS-AUTO-RP - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/global-group-mappings-auto-rp/

Update operation of resource: global-group-mappings-auto-rp

global-group-mappings-auto-rp_schema

global-group-mappings-auto-rpbody object

Request Content-Types: application/json
Request Example
{
  : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
    
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

    
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-GROUP-MAPPINGS-AUTO-RP - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/global-group-mappings-auto-rp/

Create operation of resource: global-group-mappings-auto-rp

global-group-mappings-auto-rp_schema

global-group-mappings-auto-rpbody object

Request Content-Types: application/json
Request Example
{
  : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
    
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

    
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-GROUP-MAPPINGS-AUTO-RP - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/global-group-mappings-auto-rp/

Delete operation of resource: global-group-mappings-auto-rp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-GROUP-MAPPINGS-AUTO-RP - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/global-group-mappings-auto-rp/

Retrieve operation of resource: global-group-mappings-auto-rp

200 OK
global-group-mappings-auto-rp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Maximum for number of group mappings from\nautorp mapping agentPUTPOSTDELETEGET
    
"threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

    
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"

  }
}

BSR-GLOBAL-CANDIDATE-RP-CACHE - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/bsr-global-candidate-rp-cache/

Update operation of resource: bsr-global-candidate-rp-cache

bsr-global-candidate-rp-cache_schema

bsr-global-candidate-rp-cachebody object

Request Content-Types: application/json
Request Example
{
  : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-GLOBAL-CANDIDATE-RP-CACHE - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/bsr-global-candidate-rp-cache/

Create operation of resource: bsr-global-candidate-rp-cache

bsr-global-candidate-rp-cache_schema

bsr-global-candidate-rp-cachebody object

Request Content-Types: application/json
Request Example
{
  : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-GLOBAL-CANDIDATE-RP-CACHE - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/bsr-global-candidate-rp-cache/

Delete operation of resource: bsr-global-candidate-rp-cache

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-GLOBAL-CANDIDATE-RP-CACHE - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/bsr-global-candidate-rp-cache/

Retrieve operation of resource: bsr-global-candidate-rp-cache

200 OK
bsr-global-candidate-rp-cache_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default global maximum and threshold\nfor C-RP set in BSRPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"

  }
}

GLOBAL-REGISTER-STATES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/global-register-states/

Update operation of resource: global-register-states

global-register-states_schema

global-register-statesbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
    
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-REGISTER-STATES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/global-register-states/

Create operation of resource: global-register-states

global-register-states_schema

global-register-statesbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
    
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-REGISTER-STATES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/global-register-states/

Delete operation of resource: global-register-states

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-REGISTER-STATES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/global-register-states/

Retrieve operation of resource: global-register-states

200 OK
global-register-states_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
    
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}

GLOBAL-ROUTE-INTERFACES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/global-route-interfaces/

Update operation of resource: global-route-interfaces

global-route-interfaces_schema

global-route-interfacesbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
    
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-ROUTE-INTERFACES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/global-route-interfaces/

Create operation of resource: global-route-interfaces

global-route-interfaces_schema

global-route-interfacesbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
    
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-ROUTE-INTERFACES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/global-route-interfaces/

Delete operation of resource: global-route-interfaces

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-ROUTE-INTERFACES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/global-route-interfaces/

Retrieve operation of resource: global-route-interfaces

200 OK
global-route-interfaces_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
    
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}

GROUP-MAPPINGS-AUTO-RP - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/group-mappings-auto-rp/

Update operation of resource: group-mappings-auto-rp

group-mappings-auto-rp_schema

group-mappings-auto-rpbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
    
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

    
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-MAPPINGS-AUTO-RP - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/group-mappings-auto-rp/

Create operation of resource: group-mappings-auto-rp

group-mappings-auto-rp_schema

group-mappings-auto-rpbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
    
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

    
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-MAPPINGS-AUTO-RP - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/group-mappings-auto-rp/

Delete operation of resource: group-mappings-auto-rp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-MAPPINGS-AUTO-RP - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/group-mappings-auto-rp/

Retrieve operation of resource: group-mappings-auto-rp

200 OK
group-mappings-auto-rp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum for number of group\nmappings from autorp mapping agentPUTPOSTDELETEGET
    
"maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"

    
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"

  }
}

BSR-GROUP-MAPPINGS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/bsr-group-mappings/

Update operation of resource: bsr-group-mappings

bsr-group-mappings_schema

bsr-group-mappingsbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-GROUP-MAPPINGS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/bsr-group-mappings/

Create operation of resource: bsr-group-mappings

bsr-group-mappings_schema

bsr-group-mappingsbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-GROUP-MAPPINGS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/bsr-group-mappings/

Delete operation of resource: bsr-group-mappings

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-GROUP-MAPPINGS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/bsr-group-mappings/

Retrieve operation of resource: bsr-group-mappings

200 OK
bsr-group-mappings_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum and threshold for\nnumber of group mappings from BSRPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"

  }
}

REGISTER-STATES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/register-states/

Update operation of resource: register-states

register-states_schema

register-statesbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
    
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REGISTER-STATES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/register-states/

Create operation of resource: register-states

register-states_schema

register-statesbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
    
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REGISTER-STATES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/register-states/

Delete operation of resource: register-states

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REGISTER-STATES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/register-states/

Retrieve operation of resource: register-states

200 OK
register-states_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum for number of\nsparse-mode source registersPUTPOSTDELETEGET
    
"maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}

ROUTE-INTERFACES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/route-interfaces/

Update operation of resource: route-interfaces

route-interfaces_schema

route-interfacesbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
    
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTE-INTERFACES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/route-interfaces/

Create operation of resource: route-interfaces

route-interfaces_schema

route-interfacesbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
    
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTE-INTERFACES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/route-interfaces/

Delete operation of resource: route-interfaces

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTE-INTERFACES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/route-interfaces/

Retrieve operation of resource: route-interfaces

200 OK
route-interfaces_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum for number of\nroute-interfacesPUTPOSTDELETEGET
    
"maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}

BSR-CANDIDATE-RP-CACHE - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/bsr-candidate-rp-cache/

Update operation of resource: bsr-candidate-rp-cache

bsr-candidate-rp-cache_schema

bsr-candidate-rp-cachebody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
    
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-CANDIDATE-RP-CACHE - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/bsr-candidate-rp-cache/

Create operation of resource: bsr-candidate-rp-cache

bsr-candidate-rp-cache_schema

bsr-candidate-rp-cachebody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
    
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-CANDIDATE-RP-CACHE - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/bsr-candidate-rp-cache/

Delete operation of resource: bsr-candidate-rp-cache

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR-CANDIDATE-RP-CACHE - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/bsr-candidate-rp-cache/

Retrieve operation of resource: bsr-candidate-rp-cache

200 OK
bsr-candidate-rp-cache_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum and threshold for BSR\nC-RP cache settingPUTPOSTDELETEGET
    
"bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"

    
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"

  }
}

ROUTES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/routes/

Update operation of resource: routes

routes_schema

routesbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of routesPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/routes/

Create operation of resource: routes

routes_schema

routesbody object

Request Content-Types: application/json
Request Example
{
  : {
Override default maximum for number of routesPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/routes/

Delete operation of resource: routes

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/maximum/routes/

Retrieve operation of resource: routes

200 OK
routes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Override default maximum for number of routesPUTPOSTDELETEGET
    
"warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"

    
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"

  }
}

SSM - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/ssm/

Update operation of resource: ssm

ssm_schema

ssmbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IP Multicast SSMPUTPOSTDELETEGET
    
"range": "string", Access list of groups enabled with SSM

    
"disable": "boolean" TRUE if SSM is disabled on this router

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/ssm/

Create operation of resource: ssm

ssm_schema

ssmbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IP Multicast SSMPUTPOSTDELETEGET
    
"range": "string", Access list of groups enabled with SSM

    
"disable": "boolean" TRUE if SSM is disabled on this router

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/ssm/

Delete operation of resource: ssm

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/ssm/

Retrieve operation of resource: ssm

200 OK
ssm_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure IP Multicast SSMPUTPOSTDELETEGET
    
"range": "string", Access list of groups enabled with SSM

    
"disable": "boolean" TRUE if SSM is disabled on this router

  }
}

INJECTS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/injects/

Update operation of resource: injects

injects_schema

injectsbody object

Request Content-Types: application/json
Request Example
{
  : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"rpf-proxy-address": "string", RPF Proxy Address

        
"prefix-length": "string", Masklen

        
"source-address": "string" Source Address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INJECTS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/injects/

Create operation of resource: injects

injects_schema

injectsbody object

Request Content-Types: application/json
Request Example
{
  : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"rpf-proxy-address": "string", RPF Proxy Address

        
"prefix-length": "string", Masklen

        
"source-address": "string" Source Address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INJECTS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/injects/

Delete operation of resource: injects

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INJECTS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/injects/

Retrieve operation of resource: injects

200 OK
injects_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Inject Explicit PIM RPF Vector Proxy'sPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"rpf-proxy-address": "string", RPF Proxy Address

        
"prefix-length": "string", Masklen

        
"source-address": "string" Source Address

      }
    ]
  }
}

INJECT - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/injects/inject/{source-address prefix-length}/

Update operation of resource: inject

inject_schema

injectbody object

source-address prefix-length: string
in path

ID of source-address prefix-length

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"rpf-proxy-address": "string", RPF Proxy Address

      
"prefix-length": "string", Masklen

      
"source-address": "string" Source Address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INJECT - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/injects/inject/{source-address prefix-length}/

Create operation of resource: inject

inject_schema

injectbody object

source-address prefix-length: string
in path

ID of source-address prefix-length

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"rpf-proxy-address": "string", RPF Proxy Address

      
"prefix-length": "string", Masklen

      
"source-address": "string" Source Address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INJECT - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/injects/inject/{source-address prefix-length}/

Delete operation of resource: inject

source-address prefix-length: string
in path

ID of source-address prefix-length

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INJECT - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/injects/inject/{source-address prefix-length}/

Retrieve operation of resource: inject

source-address prefix-length: string
in path

ID of source-address prefix-length

200 OK
inject_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"rpf-proxy-address": "string", RPF Proxy Address

      
"prefix-length": "string", Masklen

      
"source-address": "string" Source Address

    }
  ]
}

BIDIR-RP-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/bidir-rp-addresses/

Update operation of resource: bidir-rp-addresses

bidir-rp-addresses_schema

bidir-rp-addressesbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

        
"rp-address": "string", RP address of Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BIDIR-RP-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/bidir-rp-addresses/

Create operation of resource: bidir-rp-addresses

bidir-rp-addresses_schema

bidir-rp-addressesbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

        
"rp-address": "string", RP address of Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BIDIR-RP-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/bidir-rp-addresses/

Delete operation of resource: bidir-rp-addresses

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BIDIR-RP-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/bidir-rp-addresses/

Retrieve operation of resource: bidir-rp-addresses

200 OK
bidir-rp-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure Bidirectional PIM Rendezvous PointPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

        
"rp-address": "string", RP address of Rendezvous Point

        
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

      }
    ]
  }
}

BIDIR-RP-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/bidir-rp-addresses/bidir-rp-address/{rp-address}/

Update operation of resource: bidir-rp-address

bidir-rp-address_schema

bidir-rp-addressbody object

rp-address: string
in path

ID of rp-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

      
"rp-address": "string", RP address of Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BIDIR-RP-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/bidir-rp-addresses/bidir-rp-address/{rp-address}/

Create operation of resource: bidir-rp-address

bidir-rp-address_schema

bidir-rp-addressbody object

rp-address: string
in path

ID of rp-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

      
"rp-address": "string", RP address of Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BIDIR-RP-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/bidir-rp-addresses/bidir-rp-address/{rp-address}/

Delete operation of resource: bidir-rp-address

rp-address: string
in path

ID of rp-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BIDIR-RP-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/bidir-rp-addresses/bidir-rp-address/{rp-address}/

Retrieve operation of resource: bidir-rp-address

rp-address: string
in path

ID of rp-address

200 OK
bidir-rp-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR

      
"rp-address": "string", RP address of Rendezvous Point

      
"access-list-name": "string" Access list of groups that should map to a\ngiven RP

    }
  ]
}

BSR - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/bsr/

Update operation of resource: bsr

bsr_schema

bsrbody object

Request Content-Types: application/json
Request Example
{
  : {
PIM BSR configurationPUTPOSTDELETEGET
    : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
      
"priority": "string", Priority of the CRP

      
"prefix-length": "string", Hash Mask Length for this candidate BSR

      
"address": "string" Address of Candidate-RP

    },
    : {
PIM RP configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

          
"priority": "string", Priority of the CRP

          
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

          
"mode": "string", SM or Bidir

          
"address": "string" Address of Candidate-RP

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/bsr/

Create operation of resource: bsr

bsr_schema

bsrbody object

Request Content-Types: application/json
Request Example
{
  : {
PIM BSR configurationPUTPOSTDELETEGET
    : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
      
"priority": "string", Priority of the CRP

      
"prefix-length": "string", Hash Mask Length for this candidate BSR

      
"address": "string" Address of Candidate-RP

    },
    : {
PIM RP configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

          
"priority": "string", Priority of the CRP

          
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

          
"mode": "string", SM or Bidir

          
"address": "string" Address of Candidate-RP

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/bsr/

Delete operation of resource: bsr

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BSR - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/bsr/

Retrieve operation of resource: bsr

200 OK
bsr_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
PIM BSR configurationPUTPOSTDELETEGET
    : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
      
"priority": "string", Priority of the CRP

      
"prefix-length": "string", Hash Mask Length for this candidate BSR

      
"address": "string" Address of Candidate-RP

    },
    : {
PIM RP configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

          
"priority": "string", Priority of the CRP

          
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

          
"mode": "string", SM or Bidir

          
"address": "string" Address of Candidate-RP

        }
      ]
    }
  }
}

CANDIDATE-BSR - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/bsr/candidate-bsr/

Update operation of resource: candidate-bsr

candidate-bsr_schema

candidate-bsrbody object

Request Content-Types: application/json
Request Example
{
  : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
    
"priority": "string", Priority of the Candidate BSR

    
"prefix-length": "string", Hash Mask Length for this candidate BSR

    
"address": "string" BSR Address configured

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-BSR - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/bsr/candidate-bsr/

Create operation of resource: candidate-bsr

candidate-bsr_schema

candidate-bsrbody object

Request Content-Types: application/json
Request Example
{
  : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
    
"priority": "string", Priority of the Candidate BSR

    
"prefix-length": "string", Hash Mask Length for this candidate BSR

    
"address": "string" BSR Address configured

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-BSR - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/bsr/candidate-bsr/

Delete operation of resource: candidate-bsr

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-BSR - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/bsr/candidate-bsr/

Retrieve operation of resource: candidate-bsr

200 OK
candidate-bsr_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
PIM Candidate BSR configurationPUTPOSTDELETEGET
    
"priority": "string", Priority of the Candidate BSR

    
"prefix-length": "string", Hash Mask Length for this candidate BSR

    
"address": "string" BSR Address configured

  }
}

CANDIDATE-RPS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/bsr/candidate-rps/

Update operation of resource: candidate-rps

candidate-rps_schema

candidate-rpsbody object

Request Content-Types: application/json
Request Example
{
  : {
PIM RP configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

        
"priority": "string", Priority of the CRP

        
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

        
"mode": "string", SM or Bidir

        
"address": "string" Address of Candidate-RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-RPS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/bsr/candidate-rps/

Create operation of resource: candidate-rps

candidate-rps_schema

candidate-rpsbody object

Request Content-Types: application/json
Request Example
{
  : {
PIM RP configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

        
"priority": "string", Priority of the CRP

        
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

        
"mode": "string", SM or Bidir

        
"address": "string" Address of Candidate-RP

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-RPS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/bsr/candidate-rps/

Delete operation of resource: candidate-rps

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-RPS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/bsr/candidate-rps/

Retrieve operation of resource: candidate-rps

200 OK
candidate-rps_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
PIM RP configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

        
"priority": "string", Priority of the CRP

        
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

        
"mode": "string", SM or Bidir

        
"address": "string" Address of Candidate-RP

      }
    ]
  }
}

CANDIDATE-RP - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/bsr/candidate-rps/candidate-rp/{address mode}/

Update operation of resource: candidate-rp

candidate-rp_schema

candidate-rpbody object

address mode: string
in path

ID of address mode

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

      
"priority": "string", Priority of the CRP

      
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

      
"mode": "string", SM or Bidir

      
"address": "string" Address of Candidate-RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-RP - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/bsr/candidate-rps/candidate-rp/{address mode}/

Create operation of resource: candidate-rp

candidate-rp_schema

candidate-rpbody object

address mode: string
in path

ID of address mode

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

      
"priority": "string", Priority of the CRP

      
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

      
"mode": "string", SM or Bidir

      
"address": "string" Address of Candidate-RP

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-RP - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/bsr/candidate-rps/candidate-rp/{address mode}/

Delete operation of resource: candidate-rp

address mode: string
in path

ID of address mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CANDIDATE-RP - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/bsr/candidate-rps/candidate-rp/{address mode}/

Retrieve operation of resource: candidate-rp

address mode: string
in path

ID of address mode

200 OK
candidate-rp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP

      
"priority": "string", Priority of the CRP

      
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"

      
"mode": "string", SM or Bidir

      
"address": "string" Address of Candidate-RP

    }
  ]
}

MOFRR - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/mofrr/

Update operation of resource: mofrr

mofrr_schema

mofrrbody object

Request Content-Types: application/json
Request Example
{
  : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
    
"enable": "null", Enable Multicast Only FRR

    
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

    
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
    : {
Clone multicast joinsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"source": "string", Original source address (S)

          
"prefix-length": "string", Mask length

          
"backup": "string", Backup cloned address (S2)

          
"primary": "string" Primary cloned address (S1)

        }
      ]
    },
    : {
Clone multicast trafficPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"source": "string", Original source address (S)

          
"prefix-length": "string", Mask length

          
"backup": "string", Backup cloned address (S2)

          
"primary": "string" Primary cloned address (S1)

        }
      ]
    },
    
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MOFRR - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/mofrr/

Create operation of resource: mofrr

mofrr_schema

mofrrbody object

Request Content-Types: application/json
Request Example
{
  : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
    
"enable": "null", Enable Multicast Only FRR

    
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

    
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
    : {
Clone multicast joinsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"source": "string", Original source address (S)

          
"prefix-length": "string", Mask length

          
"backup": "string", Backup cloned address (S2)

          
"primary": "string" Primary cloned address (S1)

        }
      ]
    },
    : {
Clone multicast trafficPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"source": "string", Original source address (S)

          
"prefix-length": "string", Mask length

          
"backup": "string", Backup cloned address (S2)

          
"primary": "string" Primary cloned address (S1)

        }
      ]
    },
    
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MOFRR - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/mofrr/

Delete operation of resource: mofrr

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MOFRR - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/mofrr/

Retrieve operation of resource: mofrr

200 OK
mofrr_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Multicast Only Fast Re-RoutePUTPOSTDELETEGET
    
"enable": "null", Enable Multicast Only FRR

    
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR

    
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route
    : {
Clone multicast joinsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"source": "string", Original source address (S)

          
"prefix-length": "string", Mask length

          
"backup": "string", Backup cloned address (S2)

          
"primary": "string" Primary cloned address (S1)

        }
      ]
    },
    : {
Clone multicast trafficPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"source": "string", Original source address (S)

          
"prefix-length": "string", Mask length

          
"backup": "string", Backup cloned address (S2)

          
"primary": "string" Primary cloned address (S1)

        }
      ]
    },
    
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR

  }
}

CLONE-JOINS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/mofrr/clone-joins/

Update operation of resource: clone-joins

clone-joins_schema

clone-joinsbody object

Request Content-Types: application/json
Request Example
{
  : {
Clone multicast joinsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"source": "string", Original source address (S)

        
"prefix-length": "string", Mask length

        
"backup": "string", Backup cloned address (S2)

        
"primary": "string" Primary cloned address (S1)

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLONE-JOINS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/mofrr/clone-joins/

Create operation of resource: clone-joins

clone-joins_schema

clone-joinsbody object

Request Content-Types: application/json
Request Example
{
  : {
Clone multicast joinsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"source": "string", Original source address (S)

        
"prefix-length": "string", Mask length

        
"backup": "string", Backup cloned address (S2)

        
"primary": "string" Primary cloned address (S1)

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLONE-JOINS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/mofrr/clone-joins/

Delete operation of resource: clone-joins

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLONE-JOINS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/mofrr/clone-joins/

Retrieve operation of resource: clone-joins

200 OK
clone-joins_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Clone multicast joinsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"source": "string", Original source address (S)

        
"prefix-length": "string", Mask length

        
"backup": "string", Backup cloned address (S2)

        
"primary": "string" Primary cloned address (S1)

      }
    ]
  }
}

CLONE-JOIN - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/mofrr/clone-joins/clone-join/{source primary backup prefix-length}/

Update operation of resource: clone-join

clone-join_schema

clone-joinbody object

source primary backup prefix-length: string
in path

ID of source primary backup prefix-length

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"source": "string", Original source address (S)

      
"prefix-length": "string", Mask length

      
"backup": "string", Backup cloned address (S2)

      
"primary": "string" Primary cloned address (S1)

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLONE-JOIN - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/mofrr/clone-joins/clone-join/{source primary backup prefix-length}/

Create operation of resource: clone-join

clone-join_schema

clone-joinbody object

source primary backup prefix-length: string
in path

ID of source primary backup prefix-length

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"source": "string", Original source address (S)

      
"prefix-length": "string", Mask length

      
"backup": "string", Backup cloned address (S2)

      
"primary": "string" Primary cloned address (S1)

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLONE-JOIN - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/mofrr/clone-joins/clone-join/{source primary backup prefix-length}/

Delete operation of resource: clone-join

source primary backup prefix-length: string
in path

ID of source primary backup prefix-length

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLONE-JOIN - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/mofrr/clone-joins/clone-join/{source primary backup prefix-length}/

Retrieve operation of resource: clone-join

source primary backup prefix-length: string
in path

ID of source primary backup prefix-length

200 OK
clone-join_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"source": "string", Original source address (S)

      
"prefix-length": "string", Mask length

      
"backup": "string", Backup cloned address (S2)

      
"primary": "string" Primary cloned address (S1)

    }
  ]
}

CLONE-SOURCES - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/mofrr/clone-sources/

Update operation of resource: clone-sources

clone-sources_schema

clone-sourcesbody object

Request Content-Types: application/json
Request Example
{
  : {
Clone multicast trafficPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"source": "string", Original source address (S)

        
"prefix-length": "string", Mask length

        
"backup": "string", Backup cloned address (S2)

        
"primary": "string" Primary cloned address (S1)

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLONE-SOURCES - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/mofrr/clone-sources/

Create operation of resource: clone-sources

clone-sources_schema

clone-sourcesbody object

Request Content-Types: application/json
Request Example
{
  : {
Clone multicast trafficPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"source": "string", Original source address (S)

        
"prefix-length": "string", Mask length

        
"backup": "string", Backup cloned address (S2)

        
"primary": "string" Primary cloned address (S1)

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLONE-SOURCES - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/mofrr/clone-sources/

Delete operation of resource: clone-sources

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLONE-SOURCES - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/mofrr/clone-sources/

Retrieve operation of resource: clone-sources

200 OK
clone-sources_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Clone multicast trafficPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"source": "string", Original source address (S)

        
"prefix-length": "string", Mask length

        
"backup": "string", Backup cloned address (S2)

        
"primary": "string" Primary cloned address (S1)

      }
    ]
  }
}

CLONE-SOURCE - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/mofrr/clone-sources/clone-source/{source primary backup prefix-length}/

Update operation of resource: clone-source

clone-source_schema

clone-sourcebody object

source primary backup prefix-length: string
in path

ID of source primary backup prefix-length

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"source": "string", Original source address (S)

      
"prefix-length": "string", Mask length

      
"backup": "string", Backup cloned address (S2)

      
"primary": "string" Primary cloned address (S1)

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLONE-SOURCE - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/mofrr/clone-sources/clone-source/{source primary backup prefix-length}/

Create operation of resource: clone-source

clone-source_schema

clone-sourcebody object

source primary backup prefix-length: string
in path

ID of source primary backup prefix-length

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"source": "string", Original source address (S)

      
"prefix-length": "string", Mask length

      
"backup": "string", Backup cloned address (S2)

      
"primary": "string" Primary cloned address (S1)

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLONE-SOURCE - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/mofrr/clone-sources/clone-source/{source primary backup prefix-length}/

Delete operation of resource: clone-source

source primary backup prefix-length: string
in path

ID of source primary backup prefix-length

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLONE-SOURCE - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/mofrr/clone-sources/clone-source/{source primary backup prefix-length}/

Retrieve operation of resource: clone-source

source primary backup prefix-length: string
in path

ID of source primary backup prefix-length

200 OK
clone-source_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"source": "string", Original source address (S)

      
"prefix-length": "string", Mask length

      
"backup": "string", Backup cloned address (S2)

      
"primary": "string" Primary cloned address (S1)

    }
  ]
}

PATHS - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/paths/

Update operation of resource: paths

paths_schema

pathsbody object

Request Content-Types: application/json
Request Example
{
  : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"rpf-proxy-address": "string", RPF Proxy Address

        
"prefix-length": "string", Masklen

        
"source-address": "string" Source Address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PATHS - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/paths/

Create operation of resource: paths

paths_schema

pathsbody object

Request Content-Types: application/json
Request Example
{
  : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"rpf-proxy-address": "string", RPF Proxy Address

        
"prefix-length": "string", Masklen

        
"source-address": "string" Source Address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PATHS - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/paths/

Delete operation of resource: paths

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PATHS - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/paths/

Retrieve operation of resource: paths

200 OK
paths_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Inject PIM RPF Vector Proxy'sPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"rpf-proxy-address": "string", RPF Proxy Address

        
"prefix-length": "string", Masklen

        
"source-address": "string" Source Address

      }
    ]
  }
}

PATH - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/paths/path/{source-address prefix-length}/

Update operation of resource: path

path_schema

pathbody object

source-address prefix-length: string
in path

ID of source-address prefix-length

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"rpf-proxy-address": "string", RPF Proxy Address

      
"prefix-length": "string", Masklen

      
"source-address": "string" Source Address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PATH - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/paths/path/{source-address prefix-length}/

Create operation of resource: path

path_schema

pathbody object

source-address prefix-length: string
in path

ID of source-address prefix-length

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"rpf-proxy-address": "string", RPF Proxy Address

      
"prefix-length": "string", Masklen

      
"source-address": "string" Source Address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PATH - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/paths/path/{source-address prefix-length}/

Delete operation of resource: path

source-address prefix-length: string
in path

ID of source-address prefix-length

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PATH - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/paths/path/{source-address prefix-length}/

Retrieve operation of resource: path

source-address prefix-length: string
in path

ID of source-address prefix-length

200 OK
path_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"rpf-proxy-address": "string", RPF Proxy Address

      
"prefix-length": "string", Masklen

      
"source-address": "string" Source Address

    }
  ]
}

ALLOW-RP - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/allow-rp/

Update operation of resource: allow-rp

allow-rp_schema

allow-rpbody object

Request Content-Types: application/json
Request Example
{
  : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
    
"rp-list-name": "string", Access-list specifiying applicable RPs

    
"group-list-name": "string" Access-list specifiying applicable groups

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ALLOW-RP - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/allow-rp/

Create operation of resource: allow-rp

allow-rp_schema

allow-rpbody object

Request Content-Types: application/json
Request Example
{
  : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
    
"rp-list-name": "string", Access-list specifiying applicable RPs

    
"group-list-name": "string" Access-list specifiying applicable groups

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ALLOW-RP - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/allow-rp/

Delete operation of resource: allow-rp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ALLOW-RP - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/allow-rp/

Retrieve operation of resource: allow-rp

200 OK
allow-rp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Enable allow-rp filtering for SM joinsPUTPOSTDELETEGET
    
"rp-list-name": "string", Access-list specifiying applicable RPs

    
"group-list-name": "string" Access-list specifiying applicable groups

  }
}

CONVERGENCE - Update

PUT Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/convergence/

Update operation of resource: convergence

convergence_schema

convergencebody object

Request Content-Types: application/json
Request Example
{
  : {
Configure convergence parametersPUTPOSTDELETEGET
    
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

    
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONVERGENCE - Create

POST Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/convergence/

Create operation of resource: convergence

convergence_schema

convergencebody object

Request Content-Types: application/json
Request Example
{
  : {
Configure convergence parametersPUTPOSTDELETEGET
    
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

    
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONVERGENCE - Delete

DELETE Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/convergence/

Delete operation of resource: convergence

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONVERGENCE - Retrieve

GET Cisco-IOS-XR-ipv4-pim-cfg:pim/default-context/ipv4/convergence/

Retrieve operation of resource: convergence

200 OK
convergence_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure convergence parametersPUTPOSTDELETEGET
    
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"

    
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"

  }
}